Sign in

v1

latestOpenAPI 3.0.12026-07-226992320.0 KB
Webhooks

Get Webhook

Retrieves the full configuration of a single webhook by webhookId. Returns the target URL, scoped agent, subscribed event types, and active status. The HMAC secret is not returned after creation — store it securely when the webhook is first created.

get/v1/webhooks/{webhookId}

Path parameters

webhookIdstring required

Unique identifier of the webhook to retrieve. Obtained from the webhookId field in the Create Webhook or List Webhooks response.

Response

OK

workspaceIdstring

Unique identifier of the workspace this webhook belongs to. Use this value to scope queries or filter webhooks by workspace.

webhookIdstring

Unique identifier for this webhook. Use this value as webhookId when updating, deleting, or retrieving this webhook via the API.

namestring

Display name of this webhook as set at creation time. Used to identify it in listings and dashboards.

agentIdstring

Unique identifier of the agent this webhook is scoped to. Only events originating from this agent are delivered to this webhook's URL.

activeboolean

Whether this webhook is currently active and will receive event deliveries. When false, the webhook is registered but no events are sent to the URL. Toggle this to pause or resume delivery without deleting the webhook.

secretstring

HMAC secret key used to sign outgoing webhook payloads. The system includes a signature header on each delivery computed using this secret. Verify the signature on your server to confirm payloads are genuinely from SigmaMind. Store this value securely — it is only returned at creation time.

eventsstring[]

Event types this webhook is subscribed to. Only events in this list trigger a delivery to the webhook URL. 'conversation_started' fires when an agent session begins. 'conversation_ended' fires when a session closes. 'conversation_analysed' fires when post-call analysis is complete.

urlstring

Example response

{
  "workspaceId": "org_BUbkx3PsbzQm5V10",
  "webhookId": "wh_BUbkx3PsbzQm5V10",
  "name": "Call Events - Production",
  "agentId": "D5D0p7TUs66TTAEAx",
  "active": true,
  "secret": "mK9vXq2pL8nR5tY1wA3sD6fH0jC4bE7u"
}