Webhook

Handle an event

postWebhookevent

Payload

idstring uuid required

ID of this event. Must be used for idempotence: an event with the same ID can be sent multiple times in case of error, but should only be processed once.

datestring date-time required

Event creation date, in ISO8601 format.

event_type'account_created' | 'account_updated' | 'account_closed' | 'attachment_created' | 'attachment_deleted' | 'bank_statement_created' | 'collection_confirmed' | 'collection_returned' | 'collection_canceled' | 'collection_failed' | 'iban_created' | 'iban_updated' | 'iban_deleted' | 'transaction_scheduled' | 'transaction_authorized' | 'transaction_confirmed' | 'transaction_rejected' | 'transaction_canceled' | 'transfer_confirmed' | 'transfer_returned' | 'transfer_canceled' | 'transfer_failed' | 'wire_transfer_confirmed' | 'wire_transfer_returned' | 'wire_transfer_canceled' | 'wire_transfer_failed' | 'wire_transfer_attachment_required' | 'bulk_transfers_completed' | 'bulk_collections_completed' | 'mandate_signature_request_sent' | 'mandate_signature_request_expired' | 'mandate_signature_request_completed' | 'mandate_signature_request_deleted' | 'account_assessment_failed' | 'account_assessment_completed' required

Type of event. We may add additional possible types over time; your application should be able to handle such additions gracefully.

resource_type'account' | 'attachment' | 'bank_statement' | 'collection' | 'iban' | 'transaction' | 'transfer' | 'wire_transfer' | 'bulk_transfers' | 'bulk_collections' | 'mandate_signature_request' | 'account_assessment' required

Type of the resource referenced by this event. We may add additional possible source types over time; your application should be able to handle such additions gracefully.

resource_idstring uuid required

ID of the resource referenced by this event.

Example payload

{
  "id": "ad8340e7-0675-4182-9c95-520e7c9a72a3",
  "resource_id": "5400f1ad-788c-4bef-9ded-4d7afd8472d7"
}

Response

No content

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.