Change a webhook's events or description, or switch it on or off

PATCH

/v1/webhooks/{id}

Switching an endpoint back on clears its failure count. The URL cannot be changed: delete the endpoint and add a new one, which also gives it a new secret.

Auth: Secret key only.

Authorizations

• SecretApiKey

Parameters

Path Parameters

id

required

string

Webhook endpoint id (whe_…)

Request Body ^required

object

events

Array<string>

Allowed values: * waitlist.signup.created waitlist.signups.invited changelog.entry.published changelog.subscriber.created feedback.created

description

string

nullable <= 200 characters

status

string

Allowed values: enabled disabled

Responses

200

The endpoint

401

Error envelope. See error.code for the discriminator.

object

data

required

null

error

required

object

code

required

string

message

required

string

remediation

required

string

doc_url

string format: uri

param

string

request_id

string

meta

object

key

additional properties

403

Error envelope. See error.code for the discriminator.

object

data

required

null

error

required

object

code

required

string

message

required

string

remediation

required

string

doc_url

string format: uri

param

string

request_id

string

meta

object

key

additional properties

404

Error envelope. See error.code for the discriminator.

object

data

required

null

error

required

object

code

required

string

message

required

string

remediation

required

string

doc_url

string format: uri

param

string

request_id

string

meta

object

key

additional properties