本文档由 Apifox 自动生成，推荐使用 Apifox - API 文档、API 调试、API Mock、API 自动化测试！

Register Webhook

Develop Env

https://echo.apifox.com/anything

POST

/webhooks/subscribe

Last modified:2025-02-20 07:53:20

Maintainer:Not configured

This endpoint allows you to register a new webhook.

Note

The webhook used is to notify/update/delete an external service when an event has occurred.

To trigger your webhook to send data, you can choose one event from the List Events endpoint.

Information

Request

Authorization

Add the parameter

Authorization

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

Example:

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

Body Params application/json

Example

{
    "name": "Salla Update Customer Event",
    "event": "customer.updated",
    "url": "https://webhook.site/07254470-c763-4ee3-bef1-ab2480262814",
    "version": 2,
    "rule": "payment_method = mada OR price < 50",
    "headers": [
        {
            "key": "Your Secret token key name",
            "value": "Your Secret token value"
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://echo.apifox.com/anything/webhooks/subscribe' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Salla Update Customer Event",
    "event": "customer.updated",
    "url": "https://webhook.site/07254470-c763-4ee3-bef1-ab2480262814",
    "version": 2,
    "rule": "payment_method = mada OR price < 50",
    "headers": [
        {
            "key": "Your Secret token key name",
            "value": "Your Secret token value"
        }
    ]
}'

Responses

🟢200New webhook has been registered successfully

application/json

Body

Examples

Webhook V2Webhook V1

{
    "status": 200,
    "success": true,
    "data": {
        "id": 60587520,
        "name": "Salla Update Customer Event",
        "event": "customer.updated",
        "type": "manual",
        "url": "https://webhook.site/07254470-c763-4ee3-bef1-ab2480262814",
        "version": 2,
        "rule": "payment_method = mada OR price < 50",
        "headers": {
            "Authorization": "abcd1234",
            "Accept-Language": "AR"
        }
    }
}

🟠422Error Validation

🟠401Unauthorized

Modified at 2025-02-20 07:53:20

List Events

Deactivate Webhook