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

​
GET - Get subscription details

​
webhookId
string
required
Webhook subscription UUID
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.
​
name
string
Updated display name
​
url
string
Updated webhook URL (must be HTTPS)
​
events
string[]
Updated event list
​
is_active
boolean
Enable or disable the subscription
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. 
curl -X DELETE "https://app.ranked.ai/api/v1/webhooks/{webhookId}" \
  -H "Authorization: Bearer rk_live_your_write_key"