Manage Webhook

Get, update, or delete a webhook subscription

GEThttps://app.ranked.ai/api/v1/webhooks/{webhookId}

GET - Get subscription details

webhookIdstringrequired

Webhook subscription UUID

Request

curl "https://app.ranked.ai/api/v1/webhooks/{webhookId}" \
  -H "Authorization: Bearer rk_live_your_api_key"

PATCH - Update subscription

Requires a Read + Write API key.

namestringbody

Updated display name

urlstringbody

Updated webhook URL (must be HTTPS)

eventsstring[]body

Updated event list

is_activebooleanbody

Enable or disable the subscription

Request

curl -X PATCH "https://app.ranked.ai/api/v1/webhooks/{webhookId}" \
  -H "Authorization: Bearer rk_live_your_write_key" \
  -H "Content-Type: application/json" \
  -d '{ "is_active": false }'

DELETE - Delete subscription

Requires a Read + Write API key.

Request

curl -X DELETE "https://app.ranked.ai/api/v1/webhooks/{webhookId}" \
  -H "Authorization: Bearer rk_live_your_write_key"

This page is also available as markdown for AI agents, and the whole reference as an OpenAPI spec. Questions? Developer support.