---
title: "Create SMS Webhook"
method: POST
path: "/dev/webhook/v2/sms"
---

# Create SMS Webhook

`POST /dev/webhook/v2/sms`

## Request

- Base URL: `https://www.fast2sms.com`
- URL: `https://www.fast2sms.com/dev/webhook/v2/sms`
- Auth: none declared. Required headers: `Authorization`

Create a new webhook configuration for the SMS service.

## Headers

- `Authorization` string, required

## Request body

- SmsWebhookConfig
  - `name` string, required: Webhook Name - Friendly label for the webhook configuration
  - `template` 'custom' | 'clevertap', required: Select Format - Webhook format to use. Choosing a format other than 'custom' (Standard Webhook) will lock the Select Event, Method, Content-Type, and Body parameters.
  - `event` 'all' | 'delivered' | 'failed', required: Select Event - Filter event triggers. (Locked when format is not Standard Webhook).
  - `identity_id` string: Entity ID - Associated Entity ID (optional). Defaults to 'all'. Only visible when Select Service is SMS.
  - `method` 'POST' | 'GET' | 'PUT', required: Method - HTTP method to invoke. (Locked when format is not Standard Webhook).
  - `url` string, required: URL - Target endpoint URL to send payloads to.
  - `content_type` 'application/json' | 'application/x-www-form-urlencoded' | 'application/xml', required: Content-Type - Target encoding format for payload transmission. (Locked when format is not Standard Webhook).
  - `payload_transform` 'standard' | 'raw_json', required: X-Payload-Transform - Payload transform type. Shown only when Content-Type is Form URL Encoded.
  - `status` 'active' | 'inactive', required: Webhook Status - Whether the webhook trigger is active (active/inactive).
  - `payload` string: Body - Custom payload template structure (JSON/XML). Use dynamic placeholders like @{{request_id}}, @{{status}}, etc. (Locked when format is not Standard Webhook).
  - `headers` object: Key-value pairs of custom headers to forward with the payload
  - `payload_type` 'SIMPLIFIED' | 'RAW', required: Payload formatting level

## Response `200`

Webhook configuration saved successfully.

---

[API](https://skmtc.dev/fast2sms/apis/developer-webhooks-new-api.md) - [All operations](https://skmtc.dev/fast2sms/apis/developer-webhooks-new-api/llms.txt) - [OpenAPI document](https://skmtc.dev/fast2sms/apis/developer-webhooks-new-api/revisions/808793762ef5?raw)