Sign in

v1

latestOpenAPI 3.1.02026-08-0670151364.9 KB
Webhooks

Create a webhook

post/apps/{clientId}/webhooks

Path parameters

clientIdstring required

The application identifier

The application identifier

Request body

urlstring

The url of the webhook target.

eventsstring[]

The list of events to subscribe.

namestring

The name of the webhook.

descriptionstring

The description of the webhook.

Example request

{
  "url": "https://hooks.example.com/adfin/webhooks",
  "events": [
    "invoice",
    "dd-mandate"
  ],
  "name": "Adfin Events",
  "description": "Triggers for invoice lifecycle events."
}

Response

The created webhook

idstring

The identifier of the webhook

clientIdstring

The identifier of the application

urlstring

The target URL of the webhook

namestring

Name of the webhook

descriptionstring

Description of the webhook

eventsstring[]

The list of event types to trigger webhook instantiation

enabledboolean

The state of the webhook

creationTimestring date-time

The creation timestamp of the webhook

lastUpdatedTimestring date-time

The last updated timestamp of the webhook