Events

Create an event

Changed on
post/events/

Request

Request body

event_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' | 'modify_notification' | 'entity_group_created' | 'entity_group_updated' | 'card_created' | 'card_updated' | 'device_created' | 'device_updated' required
external_event_idstring
event_statusstring

Event statuses are customer-defined values.

Example request

{
  "external_event_id": "audit-event-123",
  "event_status": "successful",
  "data": {
    "addresses": [
      {
        "type": "primary",
        "line_1": "41 E. 11th",
        "line_2": "2nd floor",
        "city": "New York",
        "state": "NY",
        "country_code": "US"
      }
    ],
    "emails": [
      {
        "email_address": "events@alloy.com"
      }
    ],
    "external_entity_ids": [
      {
        "external_entity_id_type": "cif"
      }
    ]
  }
}

Response

Event has been processed

status_codestring
errorobject

error details

Changes

    • breaking

      added to the request property allOf list

    • breaking

      removed subschema #1: Person Created data subschema #2: Person Updated data subschema #3: Business Created data subschema #4: Business Updated data subschema #5: Bank Account Created data subschema #6: Bank Account Updated data subschema #7: Credentials Updated data subschema #8: Embedded Authentication data subschema #9: External Account Created data subschema #10: External Account Updated data subschema #11: Login data subschema #12: Modify Notification data subschema #13: Transaction data subschema #14: Entity Group Created data subschema #15: Entity Group Updated data from the request property oneOf list

    • info

      added the new device_created enum value to the request property

    • info

      added the new device_updated enum value to the request property

    • info

      added to the request property oneOf list

    • info

      added to the response body allOf list for the response status

    • info

      added to the response body allOf list for the response status

    • info

      added to the response body allOf list for the response status

    • info

      removed from the response body allOf list for the response status

    • info

      removed from the response body allOf list for the response status

    • info

      removed subschema #1 from the response body allOf list for the response status