Webhooks

Update Webhook

Update a webhook.

patch/api/v1/webhooks/{webhook_id}

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/{webhook_id}
  • Auth: none declared

Path parameters

webhook_idstring required

Request body

namestring nullable
urlstring nullable
eventsstring[] nullable
ranking_idsstring[] nullable
is_activeboolean nullable

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

Changes

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