Webhook endpoints

Update a webhook endpoint

Scope: webhooks:write (or write)

post/v1/webhook_endpoints/{id}

Request

  • Base URL: https://api.affiliaterail.com
  • URL: https://api.affiliaterail.com/v1/webhook_endpoints/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Prefixed id (whe_…)

Example:whe_7uSyy9FqVLCFWrdPeZaK

Request body

urlstring uri
event_typesstring[]
enabledboolean

Response

The updated endpoint

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.