Patch Endpoint

patch

https://api.sinay.ai/webhook/api/v1/endpoint/{endpoint_id}

Partially update an endpoint.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

endpoint_id

string

required

length between 1 and 256

The ep's ID or UID To retrieve your endpoints ids, use GET /endpoint.

Body Params

description

string

rateLimit

uint16 | null

≥ 0

Rate limit of your endpoint in messages per second. This is an advanced field. Be aware that setting a low rateLimit can lead to a congestion queue and create delay in webhooks.

uid

string | null

The ep's UID

url

uri

Public url in your services where you plan to receive our webhooks.

version

uint16

≥ 1

deprecated

disabled

boolean

When disabled is true, no messages will be sent to your endpoint. This can be used to deactivate a development or a testing endpoint when not in use.

filterTypes

array of strings | null

filterTypes

channels

array of strings | null

List of message channels this endpoint listens to (omit for all)

channels

secret

string | null

The endpoint's verification secret. If null is passed, a secret is automatically generated. Format: base64 encoded random bytes optionally prefixed with whsec_. Recommended size: 24.

metadata

object

Optional additional properties for your endpoint.

Responses

Language

Credentials

Header

Loading…

Response

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

application/json

200

400Bad request

403Forbidden

404Not Found. The endpoint has not been found.

409Conflict. The endpoint id is already used.

422Validation Error. The payload does not have the necessary information or format.

429Too Many Requests

500Internal Error