Sign in

v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
Webhooks

Get webhook event

Get webhook event by ID

get/webhooks/{webhook_id}/events/{event_id}

Path parameters

event_idstring uuid required
Example:b01db9c7-78f2-4a99-8aca-1231d32f9b96

Webhook event ID

webhook_idstring uuid required
Example:b01db9c7-78f2-4a99-8aca-1231d32f9b96

Webhook ID

Response

Webhook event

event_resourcestring

Json string of object associated with the event. For example, if your event is ACCOUNT.CREATED, You can refer to Acccount to parse the account event to obtain the ID, status etc.

event_resource_changed_fieldsstring

Json string of object associated with the event related to a resource change. This only contains those fields that have value changed on the event, and the field values are prior to the resource change event.

event_timestring date-time

Timestamp of the current event raised

idstring uuid

Unique event ID of the webhook request. Use event endpoints to get more event summary data

metadatastring

Metadata that stored in the webhook subscription

resource_idstring uuid

The ID of the resource this event occurred on, if available.

status'FAILED' | 'RETRYING' | 'RUNNING' | 'SUCCESS'

Current event status. Failing event will keep retry until it is purged.

type'ACCOUNT.CREATED' | 'ACCOUNT.UPDATED' | 'ACH.INCOMING.FUTURE_DATED' | 'ADDRESS.CREATED' | 'ADDRESS.UPDATED' | 'APPLICATION.CREATED' | 'APPLICATION.UPDATED' | 'BUSINESS.CREATED' | 'BUSINESS.UPDATED' | 'BUSINESS.VERIFICATION_OUTCOME.UPDATED' | 'CARD.CREATED' | 'CARD.DIGITALWALLETTOKEN.CREATED' | 'CARD.DIGITALWALLETTOKEN.UPDATED' | 'CARD.IMAGE.UPDATED' | 'CARD.THREE_DS.AUTHENTICATION' | 'CARD.THREE_DS.DECISION' | 'CARD.UPDATED' | 'CASE.CREATED' | 'CASE.UPDATED' | 'CASH_PICKUP.CREATED' | 'CASH_PICKUP.UPDATED' | 'CREDIT_SCORE.CREATED' | 'CRR.CREATED' | 'CUSTOMER.CREATED' | 'CUSTOMER.KYC_OUTCOME.UPDATED' | 'CUSTOMER.UPDATED' | 'DOCUMENT.CREATED' | 'DOCUMENT.DELETED' | 'DOCUMENT.RETRIEVED' | 'DOCUMENT.UPDATED' | 'DOCUMENT_VERIFICATION_SESSION.CREATED' | 'DOCUMENT_VERIFICATION_SESSION.UPDATED' | 'EDD.CREATED' | 'EDD.DELETED' | 'EXTERNAL_CARD.CREATED' | 'EXTERNAL_CARD.DELETED' | 'EXTERNAL_CARD.UPDATED' | 'EXTERNAL_CARD_TRANSFER.CREATED' | 'EXTERNAL_CARD_TRANSFER.UPDATED' | 'INTEREST.MONTHLY_PAYOUT' | 'INTERNAL_ACCOUNT.CREATED' | 'INTERNAL_ACCOUNT.UPDATED' | 'INTERNAL_TRANSFER.SUCCEEDED' | 'NOTE.CREATED' | 'NOTE.UPDATED' | 'PAYMENT_SCHEDULE.CREATED' | 'PAYMENT_SCHEDULE.PAYMENT.CREATED' | 'PAYMENT_SCHEDULE.UPDATED' | 'PERSON.CREATED' | 'PERSON.UPDATED' | 'PERSON.VERIFICATION_OUTCOME.UPDATED' | 'RESOURCE_MAPPING.CREATED' | 'RESOURCE_MAPPING.DELETED' | 'RESOURCE_MAPPING.UPDATED' | 'SPEND_CONTROL.CREATED' | 'SPEND_CONTROL.UPDATED' | 'SPEND_CONTROL.VIOLATED' | 'STATEMENT.CREATED' | 'TRANSACTION.PENDING.CREATED' | 'TRANSACTION.PENDING.UPDATED' | 'TRANSACTION.POSTED.CREATED' | 'TRANSACTION.POSTED.UPDATED'

All the webhook event types

urlstring

URL that the current event will be sent to

webhook_idstring uuid

Webhook the current event belongs to