Webhooks

Create Webhook

Create a new webhook.

The webhook will be called whenever the specified events occur. If you generate a secret, it will be used to sign payloads for verification. Requires Pro plan or higher.

post/api/v1/webhooks

Request

  • Base URL: https://app.aimrank.io (the document declares no server; this is the origin it was published from)
  • URL: https://app.aimrank.io/api/v1/webhooks
  • Auth: none declared

Request body

namestring required
urlstring required
eventsstring[]
ranking_idsstring[] nullable
generate_secretboolean

Response

Successful Response

idstring required
namestring required
urlstring required
eventsstring[] required
ranking_idsstring[] nullable required
is_activeboolean required
is_healthyboolean required
last_triggered_atstring date-time nullable required
last_status_codeinteger nullable required
consecutive_failuresinteger required
total_deliveriesinteger required
failed_deliveriesinteger required
created_atstring date-time required
secretstring nullable

Changes

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