Connection Webhooks

Sent to the webhook URI that you registered when:

  • a connection is authorised.
  • a connection fails.
Payload
string
enum
required
Allowed:
integer
enum
required

The version of the event schema.

Allowed:
string
required

Unique ID of the event.

string
required

Unique ID for the connection

metadata
object

Optional field for adding custom key-value data to a resource. This object can contain a maximum of 10 key-value pairs, each with a key with a maximum length of 40 characters and a non-null value with a maximum length of 500 characters.

string
required

The date and time the connection was authorized.

Headers
string
required

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

Response
200

Webhook Handled

LoadingLoading…