Create OTP Webhook

post

https://www.fast2sms.com/dev/webhook/v2/otp

Create a new webhook configuration for the OTP service.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

This endpoint allows you to create a new webhook configuration for the OTP service (up to 10 webhooks maximum).

Body Params

name

string

required

Webhook Name - Friendly label for the webhook configuration

template

string

enum

required

Defaults to custom

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.

Allowed:

event

string

enum

required

Defaults to all

Select Event - Filter event triggers. (Locked when format is not Standard Webhook).

Allowed:

method

string

enum

required

Defaults to POST

Method - HTTP method to invoke. (Locked when format is not Standard Webhook).

Allowed:

url

string

required

URL - Target endpoint URL to send payloads to.

content_type

string

enum

required

Defaults to application/json

Content-Type - Target encoding format for payload transmission. (Locked when format is not Standard Webhook).

Allowed:

payload_transform

string

enum

required

Defaults to standard

X-Payload-Transform - Payload transform type. Shown only when Content-Type is Form URL Encoded.

Allowed:

status

string

enum

required

Defaults to active

Webhook Status - Whether the webhook trigger is active (active/inactive).

Allowed:

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

string

enum

required

Defaults to SIMPLIFIED

Payload formatting level

Allowed:

Headers

Authorization

string

required

Defaults to YOUR_API_KEY

Provide "YOUR_API_KEY".

Response

200

Webhook configuration saved successfully.

Language

Loading…

Response

Click Try It! to start a request and see the response here!