webhooks

Test webhook

POST one signed synthetic envelope (type webhooks.test, or override_event_type) to the endpoint now and answer what came back: http_status, duration_ms, error_kind (none, http_error, network). Verifies the endpoint and its signature check without waiting for a real event; writes no log row, moves no counter, fires no event. Allowed on a failed webhook (the revival check), refused on one switched off (409). Throttled 10 a minute per webhook.

Contract:

  • MCP tool test_webhook, registry package mcp.integrations/webhooks, mount integrations.webhooks.
  • Operation action, response envelope action.
  • Flags: none.
post/api/webhooks/{sid}/test

Request

  • Base URL
    https://beta.getsales.io/integrations/v1
  • Auth
    HTTP bearer and API key in header Team-SID

Path parameters

sidstring required

Webhook sid (wh_hk_...).

Request body

override_event_typestring

Send the envelope under this event type instead of webhooks.test.

Response

action success envelope.

successtrue required
operation'action' required
actionstring required

kebab-case verb; matches the route segment.

Changes

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