Sign in

v1

latestOpenAPI 3.1.02026-08-06911,228852.2 KB
Order and Pay: Webhook

Retrieve a Webhook

Retrieve an existing webhook.

get/o/wh/1/webhook/{endpointId}

Path parameters

endpointIdstring required
Example:endpoint

Response

Webhook

endpointIdstring required

The unique endpoint ID, for example the integration name. Case sensitive.

urlstring required

The URL which this endpoint points to.

withBasicAuthboolean

If basic auth should be used, defaults to false.

usernamestring

The username for basic auth.

passwordstring

The password for basic auth.

provideAccountboolean

Whether or not to include account info in the notification.

expandTransactionsboolean

Whether or not to include transaction lines in the notification.

expandPaymentsboolean

Whether or not to include payment lines in the notification.

Example response

{
  "endpointId": "MY-AWESOME-ENDPOINT-ID",
  "url": "https://webhook.site/1dc40b86-3d0d",
  "withBasicAuth": true,
  "username": "username",
  "password": "password",
  "provideAccount": true,
  "expandTransactions": true,
  "expandPayments": true,
  "subscribeTo": [
    {
      "name": "DELIVERED",
      "resource": "order"
    }
  ]
}