Connection Management

Connection Webhooks

Sent to the webhook URI that you registered when:

  • a connection is authorised.
  • a connection fails.
postWebhookconnection_management

Headers

Tl-Signaturestring required

A JWS with detached content, verifiable with our public key. See Webhook Request Signing

Payload

OR

Example payload

{
  "event_id": "b8d4dda0-ff2c-4d77-a6da-4615e4bad941",
  "connection_id": "0a6273a0-0314-4db6-800a-e66225fbe9f7",
  "metadata": {
    "prop1": "value1",
    "prop2": "value2"
  },
  "authorized_at": "2025-01-01T09:01:00.000Z"
}

Response

Webhook Handled

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.