Recruit Affiliates webhooks

Create a webhook endpoint

A public https:// address, or a Slack incoming webhook address with kind: "slack". The answer carries secret this once. A test key always makes a test endpoint.

Scope: finder:write

post/v1/finder/webhook_endpoints

Request

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

Request body

urlstring required

A public https:// address

kind'webhook' | 'slack'

event_typesstring[]

Event names from the catalogue on the webhooks docs page. Leave empty for every event.

livemodeboolean

false makes a test endpoint

Response

The new endpoint, with its secret

idstring required

Prefixed id (fwe_…)

object'finder_webhook_endpoint' required

urlstring required

kind'webhook' | 'slack' required

slack sends a Slack message to a Slack incoming webhook address instead of signed JSON

event_typesstring[] required

The events this endpoint gets. Empty means every event.

enabledboolean required

livemodeboolean required

false for a test endpoint, which only gets test events

previous_secret_expires_atstring date-time nullable required

After a rotation, when the old secret stops signing. Null when only one secret is live.

created_atstring date-time required

ISO-8601, UTC

secretstring required

The signing secret. Shown here once, and never again. Keep it somewhere safe.

Example response

{
  "id": "fwe_7uSyy9FqVLCFWrdPeZaK",
  "url": "https://hooks.example.com/recruit",
  "previous_secret_expires_at": "2026-08-21T10:15:30.000Z",
  "created_at": "2026-08-21T10:15:30.000Z"
}

Changes

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