Webhooks_test

POST

/webhooks/{id}/test

const url = 'http://localhost:3000/api/webhooks/example/test';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"eventType":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url http://localhost:3000/api/webhooks/example/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "eventType": "example" }'

Send a sample event of the chosen type, signed as a real delivery, and return the receiver’s answer. Does not change the endpoint’s failure state. Needs the webhooks:test scope.

Authorizations

BearerAuth

Parameters

Path Parameters

required

A primary key, written as a decimal string so JavaScript never rounds it. The format makes the Go servers parse it into an int64: a malformed id is refused as a 400 before a handler runs. The pattern says the same in the contract, so a client (or a fuzzer) can tell a malformed id from a valid one without trying it. Eighteen digits is the most a key reaches, so every id the schema admits fits an int64.

string format: int64

/^[0-9]{1,18}$/

Unique identifier

Request Body^required

application/json

Request body for sending a sample event to a webhook endpoint

object

eventType

required

The event name the sample carries, for example contact.created

string

Example ^generated

{
  "eventType": "example"
}

Responses

200

The request has succeeded.

application/json

What the receiver answered to a test delivery. The endpoint’s failure state is not touched.

object

delivered

required

Whether the receiver answered 2xx

boolean

status

HTTP status the receiver answered, when it answered

integer format: int32

kind

Why the delivery failed; absent when delivered

string

Allowed values: timeout blocked_address http_status network

Example

{
  "kind": "timeout"
}

400

RFC 7807 bad request response

application/problem+json

RFC 7807 Problem Details

object

code

Why the request was refused, when the client should act on it

string

Allowed values: second_factor_required email_verification_required signup_closed

type

A URI reference that identifies the problem type

string

title

A short, human-readable summary of the problem type

string

status

HTTP status code

integer format: int32

detail

A human-readable explanation specific to this occurrence

string

instance

A URI reference that identifies the specific occurrence

string

errors

Validation errors grouped by field

object

key

additional properties

Array<string>

form

Form-level validation error

string

fields

Field validation errors

object

key

additional properties

string

retryAfter

Seconds to wait before retrying; set on a 429 so a client that only sees the body can show the wait

integer format: int32

debug

Why a 500 happened, sent only by a development server (SPHERICON_ENV=development)

object

error

required

The error that failed the request, or the panic value

string

stack

The goroutine stack of a panic; absent for an error a handler returned

string

requestId

The request id the server log carries for this request

string

method

required

The HTTP method of the failed request

string

path

required

The path of the failed request

string

Example

{
  "code": "second_factor_required"
}

401

RFC 7807 unauthorized response

application/problem+json

RFC 7807 Problem Details

object

code

Why the request was refused, when the client should act on it

string

Allowed values: second_factor_required email_verification_required signup_closed

type

A URI reference that identifies the problem type

string

title

A short, human-readable summary of the problem type

string

status

HTTP status code

integer format: int32

detail

A human-readable explanation specific to this occurrence

string

instance

A URI reference that identifies the specific occurrence

string

errors

Validation errors grouped by field

object

key

additional properties

Array<string>

form

Form-level validation error

string

fields

Field validation errors

object

key

additional properties

string

retryAfter

Seconds to wait before retrying; set on a 429 so a client that only sees the body can show the wait

integer format: int32

debug

Why a 500 happened, sent only by a development server (SPHERICON_ENV=development)

object

error

required

The error that failed the request, or the panic value

string

stack

The goroutine stack of a panic; absent for an error a handler returned

string

requestId

The request id the server log carries for this request

string

method

required

The HTTP method of the failed request

string

path

required

The path of the failed request

string

Example

{
  "code": "second_factor_required"
}

404

RFC 7807 not found response

application/problem+json

RFC 7807 Problem Details

object

code

Why the request was refused, when the client should act on it

string

Allowed values: second_factor_required email_verification_required signup_closed

type

A URI reference that identifies the problem type

string

title

A short, human-readable summary of the problem type

string

status

HTTP status code

integer format: int32

detail

A human-readable explanation specific to this occurrence

string

instance

A URI reference that identifies the specific occurrence

string

errors

Validation errors grouped by field

object

key

additional properties

Array<string>

form

Form-level validation error

string

fields

Field validation errors

object

key

additional properties

string

retryAfter

Seconds to wait before retrying; set on a 429 so a client that only sees the body can show the wait

integer format: int32

debug

Why a 500 happened, sent only by a development server (SPHERICON_ENV=development)

object

error

required

The error that failed the request, or the panic value

string

stack

The goroutine stack of a panic; absent for an error a handler returned

string

requestId

The request id the server log carries for this request

string

method

required

The HTTP method of the failed request

string

path

required

The path of the failed request

string

Example

{
  "code": "second_factor_required"
}

422

RFC 7807 validation response

application/problem+json

RFC 7807 Problem Details

object

code

Why the request was refused, when the client should act on it

string

Allowed values: second_factor_required email_verification_required signup_closed

type

A URI reference that identifies the problem type

string

title

A short, human-readable summary of the problem type

string

status

HTTP status code

integer format: int32

detail

A human-readable explanation specific to this occurrence

string

instance

A URI reference that identifies the specific occurrence

string

errors

Validation errors grouped by field

object

key

additional properties

Array<string>

form

Form-level validation error

string

fields

Field validation errors

object

key

additional properties

string

retryAfter

Seconds to wait before retrying; set on a 429 so a client that only sees the body can show the wait

integer format: int32

debug

Why a 500 happened, sent only by a development server (SPHERICON_ENV=development)

object

error

required

The error that failed the request, or the panic value

string

stack

The goroutine stack of a panic; absent for an error a handler returned

string

requestId

The request id the server log carries for this request

string

method

required

The HTTP method of the failed request

string

path

required

The path of the failed request

string

Example

{
  "code": "second_factor_required"
}

429

RFC 7807 too many requests response: a rate limit was exceeded (ADR 0025)

application/problem+json

RFC 7807 Problem Details

object

code

Why the request was refused, when the client should act on it

string

Allowed values: second_factor_required email_verification_required signup_closed

type

A URI reference that identifies the problem type

string

title

A short, human-readable summary of the problem type

string

status

HTTP status code

integer format: int32

detail

A human-readable explanation specific to this occurrence

string

instance

A URI reference that identifies the specific occurrence

string

errors

Validation errors grouped by field

object

key

additional properties

Array<string>

form

Form-level validation error

string

fields

Field validation errors

object

key

additional properties

string

retryAfter

Seconds to wait before retrying; set on a 429 so a client that only sees the body can show the wait

integer format: int32

debug

Why a 500 happened, sent only by a development server (SPHERICON_ENV=development)

object

error

required

The error that failed the request, or the panic value

string

stack

The goroutine stack of a panic; absent for an error a handler returned

string

requestId

The request id the server log carries for this request

string

method

required

The HTTP method of the failed request

string

path

required

The path of the failed request

string

Example

{
  "code": "second_factor_required"
}

Headers

Retry-After

required

integer format: int32

Seconds to wait before retrying

X-RateLimit-Limit

required

integer format: int32

The request budget of the window that was exceeded

X-RateLimit-Remaining

required

integer format: int32

Requests left in the current window

X-RateLimit-Reset

required

integer format: int64

Unix time at which the window resets

Webhooks_test

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Example generated

Responses

200

Example

400

Example

401

Example

404

Example

422

Example

429

Example

Headers

Request Body^required

Example ^generated