Actions

Call the createWebhookEndpoint MCP tool

Create a new outbound webhook endpoint. url must be https; a private, local, or internal host is refused. Pass at least one event type in events (see getWebhookEndpoints or the "known" list on an unknown_event error for the currently subscribable types). Optional category_filters narrows reply.* events to specific reply classifications; omit to receive every event you subscribed to. Optional campaign_filters restricts delivery to events for those campaign ids only (must be campaigns already in this workspace); omit or leave empty for every campaign. From this surface the endpoint is created INACTIVE and its signing secret is never returned: the user opens Settings > Developer > Webhooks (ui_url in the result), rotates the secret on the new endpoint to see it once, then enables it. The REST API creates it active and returns the secret directly for server-side automation.

Called through the Actions bridge: the response is that tool's own result, wrapped as { data: <tool result> } under HTTP 200. Billing, daily-cap, and confirm-step outcomes are embedded INSIDE data, never remapped to an HTTP status (see the templated /api/v1/actions/{toolName} operation above for the full protocol, and x-mcp-actions for this tool's machine-readable scope/cap/confirm_behavior fields). Authentication, request-shape, and optional idempotency-protocol failures still use their documented non-200 statuses.

post/api/v1/actions/createWebhookEndpoint

Request

  • Base URL: https://app.reachium.io
  • URL: https://app.reachium.io/api/v1/actions/createWebhookEndpoint
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Optional caller-generated key (8-200 characters: letters, digits, dot, underscore, colon, or hyphen). A final tool result is replayed for the same key and body. An ambiguous result remains 409 under that key; reconcile external state before using a new key. Reuse with a different body returns 422.

Request body

urlstring uri required

The https endpoint that will receive event payloads.

eventsstring[] required

Event types to subscribe to. Unknown values are refused, with the current known list returned.

category_filtersstring[]

Optional: only deliver reply.* events matching these reply classifications.

campaign_filtersstring[]

Optional: only deliver events for these campaign ids. Omit for every campaign.

Response

The result of calling this tool.

dataunknown required
errorunknown required

Changes

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