XExentral
Webhook

List webhook event types

Changed on

List webhooks event types.

get/api/v1/webhookEventTypes

Request

Query parameters

xentralVersionstring

Xentral version to request the available event types for.

includestring

Comma-separated list of extra data to include. Supported value: schema — adds the JSON Schema of the delivered webhook document per event type. Without it the response is unchanged; any other value is rejected with 400.

Response

Webhook event type list.

Example response

{
  "data": [
    {
      "id": "com.xentral.salesOrder.created.v1",
      "group": "salesOrder"
    },
    {
      "id": "com.xentral.product.created.v1",
      "group": "product"
    },
    {
      "id": "com.xentral.product.propertiesCreated.v1",
      "group": "product"
    }
  ]
}

Changes

  • ebe5ba2a4ed8Revision changes
    • info

      added the new optional query request parameter include

    • info

      added the non-success response with the status

    • info

      added the optional property // to the response with the status