Otter · Schema

FetchCredentialsEvent

FetchCredentialsEvent schema from Public API (Otter Public API).

RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

Properties

Name Type Description
credentials array Array of existing credentials added so far. It's used by multi step onboarding to verify if other credentials are needed based on existing ones values.
View JSON Schema on GitHub

JSON Schema

public-api-fetch-credentials-event-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "FetchCredentialsEvent",
  "description": "FetchCredentialsEvent schema from Public API (Otter Public API).",
  "$id": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-fetch-credentials-event-schema.json",
  "type": "object",
  "properties": {
    "credentials": {
      "type": "array",
      "description": "Array of existing credentials added so far. It's used by multi step onboarding to verify if other credentials are needed based on existing ones values.",
      "items": {
        "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-existing-credential-schema.json"
      },
      "example": [
        {
          "key": "email",
          "value": "[email protected]"
        },
        {
          "key": "password",
          "value": "test-pwd-1234"
        }
      ]
    }
  }
}