One webhook and its recent deliveries

GET

/v1/webhooks/{id}

const url = 'https://api.sotirea.com/v1/webhooks/1';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

curl --request GET \
  --url https://api.sotirea.com/v1/webhooks/1 \
  --header 'Authorization: Bearer <token>'

Authorizations

bearer

Parameters

Path Parameters

required

integer

The webhook’s id.

Responses

200

Done.

application/json

object

data

required

object

created_at

required

string format: date-time

created_by_name

required

The person or API key that added it.

string

deliveries

required

Its most recent deliveries, newest first.

Array<object>

object

attempts

required

integer

created_at

required

string format: date-time

delivered_at

required

Any of:

string
null

string format: date-time

event_id

required

The event’s id, the webhook-id header it is sent with: the same on every attempt and resend.

string

required

Resend it with POST /v1/webhooks/{id}/deliveries/{delivery}/resend.

integer

last_attempt_at

required

Any of:

string
null

string format: date-time

last_error

required

string

last_status

required

Any of:

integer
null

integer

status

required

Waiting, delivered or failed.

string

type

required

string

description

required

string

disabled_at

required

Any of:

string
null

string format: date-time

disabled_reason

required

string

events

required

The event types sent to it.

Array<string>

failing

required

How many deliveries gave up.

integer

required

integer

previous_secret_until

required

Any of:

string
null

string format: date-time

url

required

string

waiting

required

How many deliveries are still being tried.

integer

meta

object

request_id

Quote it when asking about a request; it is in the X-Request-Id header too.

string

success

required

Example

{
  "success": true
}

default

Refused or failed, in words a person can act on.

application/json

object

error

required

object

code

required

string

fields

object

key

additional properties

string

message

required

string

meta

object

request_id

Quote it when asking about a request.

string

success

required

Example

{
  "success": false
}