---
title: "Create Webhook"
method: POST
path: "/webhooks"
tags: ["Webhooks management"]
---

# Create Webhook

`POST /webhooks`

Register a webhook to receive event callbacks. `name`, `url`, `headers`, and `retries` are required.

**Authentication:** TextPeak API key in the `Authorization` header (see **Authentication** in the API Overview).

## Request body

- object
  - `name` string, required — Webhook name.
  - `url` string, required — Destination URL that receives the callback.
  - `webhookTrigger` 'INCOMING_MESSAGE' | 'SHORT_URL_CLICK' | 'MESSAGE_DELIVERY' | 'EDR_INFORMATION' | 'CALL_PERMISSION' — The event that fires this webhook.
  - `method` 'GET' | 'POST' — HTTP method used for the callback.
  - `filter` object — Delivery filter. Only `stream_id` is supported.
    - `stream_id` integer — Restrict callbacks to this stream.
  - `params` object — Payload options (`send_bulk`, `include_message_text`, `include_contact_details`, `include_lead_id`, `extended`).
  - `headers` object, required — Custom HTTP headers sent with each callback.
  - `retries` integer, required — Number of retry attempts on failure.
  - `activated` boolean — Whether the webhook is active.

## Response `201`

The created webhook.

- object
  - `id` integer — Unique webhook identifier.
  - `name` string — Webhook name.
  - `url` string — Destination URL that receives the callback.
  - `webhookTrigger` 'INCOMING_MESSAGE' | 'SHORT_URL_CLICK' | 'MESSAGE_DELIVERY' | 'EDR_INFORMATION' | 'CALL_PERMISSION' — The event that fires this webhook.
  - `method` 'GET' | 'POST' — HTTP method used for the callback.
  - `filter` object — Delivery filter. Only `stream_id` is supported.
    - `stream_id` integer — Restrict callbacks to this stream.
  - `params` object — Payload options.
    - `send_bulk` boolean — Batch multiple events per callback.
    - `include_message_text` boolean — Include the message body.
    - `include_contact_details` boolean — Include contact details.
    - `include_lead_id` boolean — Include the lead ID.
    - `extended` boolean — Include the extended payload.
  - `headers` object — Custom HTTP headers sent with each callback.
  - `retries` integer — Number of retry attempts on failure.
  - `activated` boolean — Whether the webhook is active.
  - `createdAt` string — When the webhook was created.
  - `updatedAt` string — When the webhook was last updated.

---

[API](https://skmtc.net/commpeak/apis/dialer-api-v2-0-1.md) · [All operations](https://skmtc.net/commpeak/apis/dialer-api-v2-0-1/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/commpeak/dialer-api-v2-0-1/revisions/eacecf960bb6/schema)