Update webhook

PATCH

/api/webhooks/hooks/{id}

curl --request PATCH \
  --url https://reignitor.com/api/webhooks/hooks/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "active": false }'

• Production.

Pause or resume a webhook, change its URL, or change its description. Updating a webhook also resets its failure count.

Authorizations

• apiKey

Parameters

Path Parameters

id

required

string

The webhook’s id.

Request Body^required

Media typeapplication/json

object

active

boolean

webhook_url

string format: uri

<= 2000 characters

description

string

<= 200 characters

Example

{
  "active": false
}

Responses

200

Updated.

Media typeapplication/json

object

hook

required

object

id

string | integer

event

string

Allowed values: user.signup user.onboarded subscription.created subscription.canceled video.completed video.failed credits.low credits.purchased

webhook_url

string

description

string | null

active

boolean

has_secret

Whether the webhook has a signing secret. The secret itself is never returned after creation.

boolean

failure_count

Failed deliveries in a row. After 20 the webhook is switched off.

integer | null

last_delivery_at

string | null

last_status

string | null

key

additional properties

any

Example

{
  "hook": {
    "event": "user.signup"
  }
}

400

URL_NOT_DELIVERABLE, or a validation error.

Media typeapplication/json

One of:

object

Every error has a human-readable error. Most also have a machine-readable code.

object

error

required

A message you can show to a person.

string

code

A stable code to branch on. Not every error has one.

string

details

Extra context for some codes, such as retryAfter or usage figures.

retryAfter

Seconds to wait before retrying. Present on some RATE_LIMITED errors.

integer

feature

string

plan

string

key

additional properties

any

object

object

error

required

string

Allowed value: Validation failed

detail

required

Every problem found, as field: message, separated by ; .

string

Example

{
  "error": "Validation failed"
}

401

The key is missing, malformed, unknown or revoked.

Media typeapplication/json

Every error has a human-readable error. Most also have a machine-readable code.

object

error

required

A message you can show to a person.

string

code

A stable code to branch on. Not every error has one.

string

details

Extra context for some codes, such as retryAfter or usage figures.

retryAfter

Seconds to wait before retrying. Present on some RATE_LIMITED errors.

integer

feature

string

plan

string

key

additional properties

any

Examples

No key, or not an emp_ key

{
  "error": "Unauthorized",
  "code": "NO_API_KEY"
}

Unknown or revoked key

{
  "error": "Invalid or revoked API key",
  "code": "INVALID_API_KEY"
}

404

No webhook with this ID on your account.

Media typeapplication/json

Every error has a human-readable error. Most also have a machine-readable code.

object

error

required

A message you can show to a person.

string

code

A stable code to branch on. Not every error has one.

string

details

Extra context for some codes, such as retryAfter or usage figures.

retryAfter

Seconds to wait before retrying. Present on some RATE_LIMITED errors.

integer

feature

string

plan

string

key

additional properties

any

Example

{
  "error": "Hook not found"
}

500

Something went wrong on our side.

Media typeapplication/json

Every error has a human-readable error. Most also have a machine-readable code.

object

error

required

A message you can show to a person.

string

code

A stable code to branch on. Not every error has one.

string

details

Extra context for some codes, such as retryAfter or usage figures.

retryAfter

Seconds to wait before retrying. Present on some RATE_LIMITED errors.

integer

feature

string

plan

string

key

additional properties

any

Example

{
  "error": "Something went wrong handling that request."
}