API Reference
Log InRequest Live Demo

Create Webhook

post
https://gw.commpeak.com/textpeak/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).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Webhook name.

string
required

Destination URL that receives the callback.

string
enum

The event that fires this webhook.

Allowed:
string
enum

HTTP method used for the callback.

Allowed:
filter
object

Delivery filter. Only stream_id is supported.

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.

integer
required

Number of retry attempts on failure.

boolean

Whether the webhook is active.

Response

Updated 1 day ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 1 day ago