List instance webhook delivery outcomes REST API

GET

/api/admin/webhooks/{webhookID}/deliveries

const url = 'https://hitkeep.com/api/admin/webhooks/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/deliveries';
const options = {method: 'GET', headers: {cookie: 'hk_token=<hk_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://hitkeep.com/api/admin/webhooks/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/deliveries \
  --cookie hk_token=<hk_token>

Deliveries use the WebhookEventPayload schema with at-least-once, unordered semantics. Verify X-HitKeep-Signature (v1=) over timestamp + “.” + body with the one-time secret, reject stale X-HitKeep-Timestamp values, and deduplicate by X-HitKeep-Event-ID or X-HitKeep-Delivery-ID. Response bodies and signing secrets are never returned.

Authorizations

cookieAuth

Parameters

Path Parameters

webhookID

required

string format: uuid

Responses

200

Delivery outcomes

application/json

Array<object>

object

attempt_count

required

integer

attempts

required

Array<object>

object

attempt_number

integer

completed_at

string format: date-time

error_code

string

error_message

string

string format: uuid

next_attempt_at

string | null format: date-time

response_status

integer

started_at

string format: date-time

status

string

completed_at

string | null format: date-time

created_at

required

string format: date-time

event_id

required

string format: uuid

event_type

required

string

required

string format: uuid

last_attempt_at

string | null format: date-time

last_error_code

string

last_error_message

string

next_attempt_at

string | null format: date-time

response_status

integer

site_id

string | null format: uuid

status

required

string

Allowed values: pending processing retrying succeeded failed

webhook_id

required

string format: uuid

Example

[
  {
    "status": "pending"
  }
]