Skip to content
Proxy Developer Docs

/webhook_endpoints/{webhook_endpoint_id} (PATCH)

PATCH
/webhook_endpoints/{webhook_endpoint_id}
curl --request PATCH \
  --url https://example.com/webhook_endpoints/example \
  --header 'Content-Type: application/json' \
  --data '{ "event_types": [ "example" ], "status": "active", "url": "example" }'

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
webhook_endpoint_id
required
string
/^whend_/

Request Bodyrequired

Section titled “ Request Bodyrequired ”
Media typeapplication/json
object
>= 1 properties
event_types
Array<string>
status
string
Allowed values: active inactive
url
string
>= 1 characters <= 2048 characters

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Default Response

Media typeapplication/json
object
webhook_endpoint
required
object
created_at
required
string format: date-time
event_schema_version
required
string
event_types
required
Array<string>
nullable
id
required
string
/^whend_/
previous_signing_secret_expires_at
required
string format: date-time
nullable
status
required
string
Allowed values: active archived inactive
updated_at
required
string format: date-time
url
required
string
Example
{
  "webhook_endpoint": {
    "status": "active"
  }
}

400

Section titled “ 400 ”

Default Response

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
request_id
required
string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "request_id": "example"
  }
}

401

Section titled “ 401 ”

Default Response

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
request_id
required
string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "request_id": "example"
  }
}

403

Section titled “ 403 ”

Default Response

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
request_id
required
string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "request_id": "example"
  }
}

404

Section titled “ 404 ”

Default Response

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
request_id
required
string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "request_id": "example"
  }
}

409

Section titled “ 409 ”

Default Response

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
request_id
required
string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "request_id": "example"
  }
}