Webhook endpoints

Create a webhook endpoint

HTTPS, public address only. The response carries secret exactly once.

Scope: webhooks:write (or write)

post/v1/webhook_endpoints

Request

Base URL: https://api.affiliaterail.com
URL: https://api.affiliaterail.com/v1/webhook_endpoints
Auth: HTTP bearer

Request body

program_idstring required

Prefixed id (prg_…)

urlstring uri required

event_typesstring[]

Empty means every event

Example request

{
  "program_id": "prg_7uSyy9FqVLCFWrdPeZaK"
}

Response

The new endpoint, with its secret

idstring required

Prefixed id (whe_…)

object'webhook_endpoint' required

program_idstring required

Prefixed id (prg_…)

partner_idstring nullable required

Prefixed id (part_…)

urlstring required

event_typesstring[] required

enabledboolean required

secretstring

Shown once, on creation

created_atstring date-time required

ISO-8601, UTC

updated_atstring date-time required

ISO-8601, UTC

Example response

{
  "id": "whe_7uSyy9FqVLCFWrdPeZaK",
  "program_id": "prg_7uSyy9FqVLCFWrdPeZaK",
  "partner_id": "part_7uSyy9FqVLCFWrdPeZaK",
  "created_at": "2026-08-21T10:15:30.000Z",
  "updated_at": "2026-08-21T10:15:30.000Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.