Recruit Affiliates webhooks

Rotate the signing secret

A new secret now. For 24 hours we sign with both, so you can swap at your own pace. The answer carries the new secret this once.

Scope: finder:write

post/v1/finder/webhook_endpoints/{id}/rotate_secret

Request

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

Path parameters

idstring required

Prefixed id (fwe_…)

Example:fwe_7uSyy9FqVLCFWrdPeZaK

Response

The endpoint, with its new 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.