Skip to content
clearance.rest

Update an endpoint

PATCH
/webhooks/endpoints/{id}
curl --request PATCH \
  --url https://api.clearance.rest/webhooks/endpoints/example \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "url": "example", "event_types": [ "example" ], "description": "example", "enabled": true }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string
>= 1 characters

Resource id.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
url
string
event_types
Array<string>
description
string | null
enabled

Enabling resets the failure counter; disabling records disabled_reason = manual.

boolean
Examplegenerated
{
  "url": "example",
  "event_types": [
    "example"
  ],
  "description": "example",
  "enabled": true
}

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
success
required
boolean
endpoint
required

A webhook subscription of the project.

object
id
required
string
url
required
string
description
required
string | null
event_types
required

Subscribed event types and patterns.

Array<string>
enabled
required
boolean
disabled_reason
required

Why the endpoint is disabled: manual (disabled through the API) or failing (disabled automatically after repeated failed deliveries); null while enabled.

string | null
consecutive_failures
required
integer
>= -9007199254740991 <= 9007199254740991
last_success_at
required
Any of:

UTC timestamp (ISO 8601).

string
last_failure_at
required
Any of:

UTC timestamp (ISO 8601).

string
created_at
required

UTC timestamp (ISO 8601).

string
updated_at
required

UTC timestamp (ISO 8601).

string
Example
{
  "success": true
}

400

Section titled “400”

Default Response

Media typeapplication/json

Error envelope returned by every JSON endpoint.

object
success
required
boolean
error
required
object
code
required

Machine-readable error code (snake_case).

string
message
required

Human-readable message.

string
details

Extra context for the error.

object
key
additional properties
Example
{
  "success": false
}

401

Section titled “401”

Default Response

Media typeapplication/json

Error envelope returned by every JSON endpoint.

object
success
required
boolean
error
required
object
code
required

Machine-readable error code (snake_case).

string
message
required

Human-readable message.

string
details

Extra context for the error.

object
key
additional properties
Example
{
  "success": false
}

403

Section titled “403”

Default Response

Media typeapplication/json

Error envelope returned by every JSON endpoint.

object
success
required
boolean
error
required
object
code
required

Machine-readable error code (snake_case).

string
message
required

Human-readable message.

string
details

Extra context for the error.

object
key
additional properties
Example
{
  "success": false
}

404

Section titled “404”

Default Response

Media typeapplication/json

Error envelope returned by every JSON endpoint.

object
success
required
boolean
error
required
object
code
required

Machine-readable error code (snake_case).

string
message
required

Human-readable message.

string
details

Extra context for the error.

object
key
additional properties
Example
{
  "success": false
}