Handle an event

POST https://webhook.example.com

Body Required

  • id string(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.

  • date string(date-time) Required

    Event creation date, in ISO8601 format.

  • event_type string Required

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

    Values are account_created, account_updated, account_closed, attachment_created, attachment_deleted, collection_confirmed, collection_canceled, collection_failed, iban_created, iban_updated, iban_deleted, transaction_scheduled, transaction_authorized, transaction_confirmed, transaction_rejected, transaction_canceled, transfer_confirmed, transfer_canceled, transfer_failed, bulk_transfers_completed, bulk_collections_completed, mandate_signature_request_sent, mandate_signature_request_expired, mandate_signature_request_completed, or mandate_signature_request_deleted.

  • resource_type string 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.

    Values are account, attachment, collection, iban, transaction, transfer, bulk_transfers, bulk_collections, or mandate_signature_request.

  • resource_id string(uuid) Required

    ID of the resource referenced by this event.

Body Required

  • id string(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.

  • date string(date-time) Required

    Event creation date, in ISO8601 format.

  • event_type string Required

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

    Values are account_created, account_updated, account_closed, attachment_created, attachment_deleted, collection_confirmed, collection_canceled, collection_failed, iban_created, iban_updated, iban_deleted, transaction_scheduled, transaction_authorized, transaction_confirmed, transaction_rejected, transaction_canceled, transfer_confirmed, transfer_canceled, transfer_failed, bulk_transfers_completed, bulk_collections_completed, mandate_signature_request_sent, mandate_signature_request_expired, mandate_signature_request_completed, or mandate_signature_request_deleted.

  • resource_type string 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.

    Values are account, attachment, collection, iban, transaction, transfer, bulk_transfers, bulk_collections, or mandate_signature_request.

  • resource_id string(uuid) Required

    ID of the resource referenced by this event.

POST event
Request examples
{
  "id": "ad8340e7-0675-4182-9c95-520e7c9a72a3",
  "date": "2024-05-04T09:42:00+00:00",
  "event_type": "account_created",
  "resource_type": "account",
  "resource_id": "5400f1ad-788c-4bef-9ded-4d7afd8472d7"
}
Request examples
{
  "id": "ad8340e7-0675-4182-9c95-520e7c9a72a3",
  "date": "2024-05-04T09:42:00+00:00",
  "event_type": "account_created",
  "resource_type": "account",
  "resource_id": "5400f1ad-788c-4bef-9ded-4d7afd8472d7"
}