Webhooks

Update a webhook subscription (rename, re-point, re-scope, pause, resume)

Resuming (is_active: true) resets the failure counter and schedules the next poll immediately. entity_ids: [] widens the scope back to every visible entity.

patch/api/v1/webhooks/{subscription_id}

Request

  • Base URL: https://api.hub-equity.com
  • URL: https://api.hub-equity.com/api/v1/webhooks/{subscription_id}
  • Auth: HTTP bearer

Path parameters

subscription_idstring required

Request body

namestring nullable
urlstring nullable
eventsstring[] nullable
entity_idsstring[] nullable

Replace the scope; send [] to watch every visible entity again.

is_activeboolean nullable

false pauses; true resumes and resets the failure counter.

Response

Successful Response

successboolean required

Changes

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