Sign in

v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
Webhooks

Create a webhook

Create a webhook

post/webhooks

Request body

descriptionstring

A description of what the webhook is used for

idstring uuid

The unique ID of the webhook

is_enabledboolean required

Set the webhook to be enabled or disabled

last_updatedstring date-time

Timestamp that this webhook was created or the last time any field was changed

metadatastring

Additional information stored to the webhook

tenantstring

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

urlstring uri required

URL that the webhook will send request to

Example request

{
  "tenant": "abcdef_ghijkl"
}

Response

Created webhook

descriptionstring

A description of what the webhook is used for

idstring uuid

The unique ID of the webhook

is_enabledboolean required

Set the webhook to be enabled or disabled

last_updatedstring date-time

Timestamp that this webhook was created or the last time any field was changed

metadatastring

Additional information stored to the webhook

tenantstring

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

urlstring uri required

URL that the webhook will send request to

Example response

{
  "tenant": "abcdef_ghijkl"
}