ALalloy
Events

Get the schema for request event type

Retrieves the schema for requested event type

get/events/schema

Request

Query parameters

type'person_created' | 'person_updated' | 'business_created' | 'business_updated' | 'bank_account_created' | 'bank_account_updated' | 'external_account_created' | 'external_account_updated' | 'transaction' | 'login' | 'credentials_updated' | 'embedded_authentication' | 'entity_group_created' | 'entity_group_updated' required
Example:login

The type of event for the schema.

Response

Returns the schema for specified events. If a workflow is attached to event, will also include supplemental data for the workflow

unknown required

Example response

{
  "status_code": 200,
  "type": "Object",
  "event_type": {
    "type": "string",
    "enum": [
      "login"
    ]
  },
  "external_event_id": {
    "type": "string",
    "nullable": true
  },
  "data": {
    "timestamp": {
      "type": "string"
    },
    "supplemental_data": {
      "type": "object",
      "properties": {}
    }
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.