Update webhook

put

https://api.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

Only the fields you send are changed.

name

length ≤ 255

Webhook name.

url

length ≤ 255

Absolute HTTPS URL that receives the callback.

webhookTrigger

enum

The event that fires this webhook. Case-sensitive.

method

enum

HTTP method used for the callback. Case-sensitive.

params

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.

filter

WebhookFilter | null

Delivery filter. Only stream_id is supported; merged into the saved filter.

headers

object | null

Custom HTTP headers sent with each callback.

retries

Number of retry attempts on failure.

activated

Whether the webhook is active.

Responses

200Successful Response

400The request could not be applied (invalid value or state).

401Missing or invalid API key.

403The API key is not allowed to use this endpoint.

404No item with this ID on your account.

422Validation Error

500The request was rejected by the server (see the endpoint description).