Skip to content
Asqary Docs

List an endpoint's deliveries

GET
/v1/webhooks/{webhook_id}/deliveries
curl --request GET \
  --url 'https://api-staging.asqary.com/v1/webhooks/example/deliveries?status=pending&limit=25' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
webhook_id
required
string
/^wh_[0-9a-f]{32}$/

Query Parameters

Section titled “Query Parameters”
status
string
Allowed values: pending succeeded failed
limit
integer
default: 25 >= 1 <= 100
cursor
string

next_cursor from the previous page.

Responses

Section titled “Responses”

200

Section titled “200”

A page of deliveries, newest first

Media typeapplication/json
object
deliveries
required
Array<object>
object
delivery_id
required
string
/^whd_[0-9a-f]{32}$/
webhook_id
required
string
/^wh_[0-9a-f]{32}$/
event_id
required
string
/^evt_[0-9a-f]{32}$/
event_type
required
string
Allowed values: backtest.completed backtest.failed policy.activated policy.archived webhook.test
status
required
string
Allowed values: pending succeeded failed
attempt_count
required
integer
next_attempt_at
required

Set while pending.

string | null format: date-time
last_attempt_at
string | null format: date-time
last_status_code
integer | null
last_error
string | null
succeeded_at
string | null format: date-time
created_at
required
string format: date-time
payload

The JSON body POSTed to your endpoint. Verify the Asqary-Signature header before trusting it (see docs/api.md#webhooks). Deliveries can repeat or arrive out of order; deduplicate on id.

object
id
required
string
/^evt_[0-9a-f]{32}$/
type
required
string
Allowed values: backtest.completed backtest.failed policy.activated policy.archived webhook.test
created_at
required
string format: date-time
environment
required
One of:
string
Allowed values: live test
data
required

backtest.*: backtest_id, status, environment, policy, dataset, summary, error, created_at, completed_at (as in GET /v1/backtest/{id}). policy.activated: policy_id, name, product, version, version_id, was_tested, replaced. policy.archived: policy_id, name, product. webhook.test: webhook_id, message.

object
key
additional properties
any
attempts

Detail only. Most recent first, up to 50.

Array<object>
object
attempted_at
string format: date-time
status_code
integer | null
duration_ms
integer
error
string | null
response_excerpt

First 512 bytes of the response body.

string | null
has_more
required
boolean
next_cursor
required
string | null

Example 

{
  "deliveries": [
    {
      "event_type": "backtest.completed",
      "status": "pending",
      "payload": {
        "type": "backtest.completed",
        "environment": "live"
      }
    }
  ]
}

404

Section titled “404”

Resource or endpoint not found.

Media typeapplication/json
object
error_code
required

Invalid_request, unauthorized, key_expired, key_revoked, forbidden, ip_not_allowed, quota_exceeded, not_found, method_not_allowed, conflict, policy_in_use, policy_active, policy_archived, idempotency_key_reused, validation_failed, rule_not_available, backtest_invalid_rows, backtest_too_large, rate_limited, internal_error

string
message
required
string
retryable
required
boolean
request_id
string
details
One of:
Array<object>
object
field
required
string
message
required
string
code
string

Example generated

{
  "error_code": "example",
  "message": "example",
  "retryable": true,
  "request_id": "example",
  "details": {}
}

422

Section titled “422”

validation_failed (details: field errors), rule_not_available, or backtest_invalid_rows.

Media typeapplication/json
object
error_code
required

Invalid_request, unauthorized, key_expired, key_revoked, forbidden, ip_not_allowed, quota_exceeded, not_found, method_not_allowed, conflict, policy_in_use, policy_active, policy_archived, idempotency_key_reused, validation_failed, rule_not_available, backtest_invalid_rows, backtest_too_large, rate_limited, internal_error

string
message
required
string
retryable
required
boolean
request_id
string
details
One of:
Array<object>
object
field
required
string
message
required
string
code
string

Example generated

{
  "error_code": "example",
  "message": "example",
  "retryable": true,
  "request_id": "example",
  "details": {}
}