Update webhook

put

https://gw.commpeak.com/textpeak/webhooks/{id}

Update a webhook. Only the fields you send are changed.

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integer

required

Unique identifier of the resource.

Body Params

name

string

required

Webhook name.

url

string

required

Destination URL that receives the callback.

webhookTrigger

string

enum

The event that fires this webhook.

Allowed:

method

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.

retries

integer

required

Number of retry attempts on failure.

activated

boolean

Whether the webhook is active.

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The updated webhook.