GEgetsales
webhooks

Create webhook

Subscribe an https endpoint to platform events: the server mints a 32-hex secret and returns it in this response ONLY (masked afterwards); the receiver verifies X-Webhook-Signature with it. target_url must be https on a public host, unique per team (409 duplicate_rejected); events is an exact list of catalog types (no wildcard); filters.account_sid narrows to one sending identity. Every producing service delivers through this one subscription.

Contract:

  • MCP tool create_webhook, registry package mcp.integrations/webhooks, mount integrations.webhooks.
  • Operation create, response envelope create.
  • Flags: dangerous: the MCP layer gates it behind a preview/commit token, and the effect cannot be undone through this API.
post/api/webhooks

Request

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

Request body

namestring required

Free text, 1..255 chars.

target_urlstring required

https only, a public host (no private or local address).

eventsstring[] required

At least one catalog event type; exact membership.

Response

create success envelope.

successtrue required
operation'create' required
already_existsboolean required

Changes

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