Subscribe a webhook event

POST

/api/v2/webhook-subscriptions

Request

Header Params

Body Params application/json

Examples

Responses

🟢200Success

application/json

Body

🔴500Server Error

🟠401Unauthorized

🟠422Parameter Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://aff-api.uppromote.com/api/v2/webhook-subscriptions' \
--header 'Accept: application/json' \
--header 'Authorization: {{API_UPROMOTE_TOKEN}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "target_url": "string",
    "event": "referral.new"
}'

Response Example

200 - Example 1

{
    "status": 200,
    "message": "success",
    "data": {
        "target_url": "https://example.com/api/referral-approved",
        "event": "referral.approved",
        "event_name": "Referral Approved",
        "version": "v1.0",
        "status": "active",
        "secret_key": "66724bc0-b9bd-434d-8cdc-********",
        "created_at": "2025-09-23T16:52:23Z",
        "updated_at": "2025-09-23T16:52:23Z"
    }
}

Modified at 2025-10-06 04:36:45

Get webhook subscriptions

Update a webhook subscription