List Events

This endpoint allows you to list all the available events that can be used in registering webhooks from this endpoint.

Information

Read more about Webhook Events here.

Scopes

webhooks.read- Webhooks Read Only

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Responses

🟢200A successful call returns a payload that contains a current list of the available webhooks events.

application/json

Body

status

number

optional

Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.

success

boolean

optional

Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.

data

array[object (Events) {3}]

optional

number

required

A unique identifier associated with the data or information received as a response to a specific event triggered by a webhook or API request.

label

string

required

A specific identifier or name used to reference and extract data from the response received when a webhook event is triggered.

event

string

required

Event text to be used to register new webhook.

Example

{
  "status": 200,
  "success": true,
  "data": [
    {
      "id": 1473353380,
      "label": "تم إنشاء طلب",
      "event": "order.created"
    },
    {
      "id": 566146469,
      "label": "تم تحديث بيانات طلب",
      "event": "order.updated"
    },
    {
      "id": 1939592358,
      "label": "تم إنشاء منتج",
      "event": "product.created"
    },
    {
      "id": 1298199463,
      "label": "تم تحديث بيانات منتج",
      "event": "product.updated"
    },
    {
      "id": 525144736,
      "label": "تم حذف منتج",
      "event": "product.deleted"
    },
    {
      "id": 1764372897,
      "label": "تمت إضافة عميل",
      "event": "customer.created"
    },
    {
      "id": 989286562,
      "label": "تم تحديث بيانات عميل",
      "event": "customer.updated"
    },
    {
      "id": 349994915,
      "label": "تمت إضافة تصنيف",
      "event": "category.created"
    },
    {
      "id": 1723506348,
      "label": "تم تحديث بيانات تصنيف",
      "event": "category.updated"
    }
  ]
}

🟠401Unauthorized

Request

Request samples

Responses