List Active Webhooks

This endpoint allows you to list all available, registered, and active webhooks related to the store.

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

🟢200OK

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 (Webhook) {8}]

optional

number

required

A unique identifier assigned to a webhook.

Example:

60587520

name

string

required

The designated label assigned to a webhook.

Example:

Salla Update Customer Event

event

string

required

An event that triggers a webhook to send real-time data between applications (from the events list).

Example:

customer.updated

type

string

required

Webhook type

url

string

required

Webhook URL is the address where a webhook sends data when a predefined event occurs.

Example:

https://webhook.site/07254470-c763-4ee3-bef1-ab2480262814

version

enum<number>

required

The webhook version, with values of 1 or 2, reflecting changes or updates to its functionality or structure.

Allowed values:

Example:

rule

string

required

operations, expressions, and conditions to your webhook, like =, !=, AND, or OR. For example: payment_method = YOUR_PAYMENT_METHOD , payment_method = mada OR price < 50
This enables precise response filtering based on your criteria.

Example:

payment_method = mada

headers

object

required

Details included in webhook requests, such as authentication and content metadata, ensure secure and accurate communication between web services. These are represented by headers.key and headers.value.

pagination

object (Pagination)

optional

For a better response behavior as well as maintain the best security level, All retrieving API endpoints use a mechanism to retrieve data in chunks called pagination. Pagination working by return only a specific number of records in each response, and through passing the page number you can navigate the different pages.

count

number

required

Number of returned results.

total

number

required

Number of all results.

perPage

number

required

Number of results per page.

<= 65

currentPage

number

required

Number of current page.

totalPages

number

required

Number of total pages.

links

object

required

Array of linkes to next and previous pages.

Example

{
    "status": 200,
    "success": true,
    "data": [
        {
            "id": 831980095,
            "name": "Customer Login",
            "event": "customer.login",
            "version": 2,
            "rule": "first_name = `User`",
            "type": "manual",
            "url": "https://webhook.site/ae7ff328-b54d-42d0-bc7c-94673cd2e982",
            "headers": {
                "Authorization": "Your Secret Token",
                "Accept-Language": "AR"
            }
        }
    ],
    "pagination": {
        "count": 0,
        "total": 0,
        "perPage": 65,
        "currentPage": 0,
        "totalPages": 0,
        "links": [
            "string"
        ]
    }
}

🟠401Unauthorized

Request

Request samples

Responses