[lightMode]

List Events

GET/webhooks/events

[updatedIn] 2 months ago

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

:::info[Information]
Read more about Webhook Events here.
:::

`webhooks.read`- Webhooks Read Only

Request

Authorization: OAuth 2.0

Add the parameter

Authorization

to [header]，whose value is to concatenate the Token after the Bearer.

[api.label.example]

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

Request samples

[api.label.responses]

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

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

HTTP Code: 200

Content Type : JSONapplication/json

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.

{
  "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"
    }
  ]
}

[updatedIn] 2 months ago