Skip to content

Send a test delivery

POST
/api/webhooks/hooks/{id}/test
curl --request POST \
--url https://reignitor.com/api/webhooks/hooks/example/test \
--header 'Authorization: Bearer <token>'

Sends one signed ping event to the webhook’s URL and reports what your endpoint answered. Use it to check your signature code.

id
required
string

The delivery was attempted. delivered is true when your endpoint answered 2xx.

Media typeapplication/json
object
delivered
required
boolean
status
required

The HTTP status your endpoint returned, or 0 if it could not be reached.

integer
error
string
Example
{
"delivered": true,
"status": 200
}

The stored URL is no longer deliverable.

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
Examplegenerated
{
"error": "example",
"code": "example",
"details": "example",
"retryAfter": 1,
"feature": "example",
"plan": "example"
}

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"
}

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"
}