v1

latestOpenAPI 3.0.02026-07-2455104.8 MB

Webhook

Update webhook

Update a webhook.

patch/api/v1/webhooks/{id}

Path parameters

idstring required

Resource identifier.

Example:17

The resource's identifier.

Request body

namestring required

urlstring uri required

signatureKeystring

Example request

{
  "name": "My example application",
  "url": "https://example.com/receive-xentral-webhook-endpoint",
  "signatureKey": "rf5ecjtvnWQ4mTDfzOTZXgQuuCSFfR66",
  "events": [
    {
      "id": "com.xentral.salesOrder.created.v1"
    },
    {
      "id": "com.xentral.salesOrder.updated.v1"
    }
  ]
}

Response

Operation completed successfully, no response body