ADadfin
Webhooks

Update a webhook

Changed on
put/apps/{clientId}/webhooks/{webhookId}

Request

  • Base URL
    https://api.adfin.com/api
  • URL
    https://api.adfin.com/api/apps/{clientId}/webhooks/{webhookId}
  • Auth
    HTTP bearer

Path parameters

clientIdstring required

The application identifier

webhookIdstring required

The webhook identifier

Request body

urlstring required

The url of the webhook target.

eventsstring[] required

The list of events to subscribe.

namestring required

The name of the webhook.

descriptionstring

The description of the webhook.

enabledboolean

The state of the webhook configuration.

Example request

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

Response

The updated 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

Changes

  • cbec1c02c8cfRevision changes
    • breaking

      the request property's minItems was increased to 1

    • breaking

      the request property's minLength was increased from 0 to 1

    • breaking

      the request property's minLength was increased from 0 to 1

  • ed46760b69c1Revision changes
    • info

      added the new payout enum value to the request property /