API Reference
Log InRequest Live Demo
  1. CommPeak TextPeak API
  2. Webhooks

Create Webhook

post
https://api.commpeak.com/textpeak/webhooks

Register a webhook to receive event callbacks. name, url, webhookTrigger and method are required.

URL. Must be an absolute https:// URL; anything else is rejected with 500.

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
length ≤ 255

Webhook name.

string
required
length ≤ 255

Absolute HTTPS URL that receives the callback. Other schemes are rejected.

string
enum
required

The event that fires this webhook. Case-sensitive.

Allowed:
string
enum
required

HTTP method used for the callback. Case-sensitive.

Allowed:
WebhookParams | null

Payload options. Stored together with filter: sending params empty or null also clears filter.stream_id, so send params before filter when you set both.

WebhookFilter | null

Delivery filter. Only stream_id is supported; other keys are dropped.

object | null
Defaults to [object Object]

Custom HTTP headers sent with each callback. Must not be null.

Number of retry attempts on failure.

Whether the webhook is active.

Responses

Updated 20 days ago

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

Updated 20 days ago

Did this page help you?