Recruit Affiliates webhooks

Send a test event

Sends one sample event to the endpoint now, once, and says what came back. It's marked livemode: false and isn't retried. It lands in the delivery log like any other.

Scope: finder:write

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

Request

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

Path parameters

idstring required

Prefixed id (fwe_…)

Example:fwe_7uSyy9FqVLCFWrdPeZaK

Request body

event_typestring

Any event from the catalogue. Defaults to the endpoint's first event, or search.completed.

Response

What the one attempt did

object'finder_webhook_test' required
delivery_idstring required

Prefixed id (fwd_…)

outcomestring required

delivered, failed, retry, skipped or pending. A test is never retried.

response_statusinteger nullable required

Example response

{
  "delivery_id": "fwd_7uSyy9FqVLCFWrdPeZaK"
}

Changes

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