Releasesv0.1.0
Api referenceEndpointsAdmin

The endpoint's deliveries (instance admin, one tenant)

GET
/v1/admin/tenants/{tenant_id}/webhooks/{webhook_id}/deliveries

GET /v1/webhooks/{webhook_id}/deliveries (listWebhookDeliveries) for the tenant of tenant_id, read with an instance admin key: the same parameters and the same answer as the tenant's own key gets. Recorded in the caller's audit log and, actor admin, in the tenant's. See docs/admin-api.md.

Authorization

tenantKey
headerAuthorizationBearer <token>

Tenant API key, ohs_sk_ + 43 base62 characters.

Path Parameters

tenant_id*string

The id of a tenant; any other value is a 404.

Formatuuid
webhook_id*string
Formatuuid

Query Parameters

status?string
Value in"pending""running""done""parked"
cursor?string

The next_cursor of the previous page.

limit?integer
Range1 <= value <= 200
Default50

Header Parameters

Authorization*string

The tenant API key, as a bearer secret.

Response Body

A page of deliveries.

application/json
  1. response
data*array<>
next_cursor*|

Null on the last page.

curl -X GET 'http://localhost:8080/v1/admin/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08/deliveries' \  -H 'Authorization: Bearer ohs_sk_...'
{  "next_cursor": "string",  "data": [    {      "id": 0,      "event_id": "a7a26ff2-e851-45b6-9634-d595f45458b7",      "event_type": "string",      "status": "pending",      "attempts": 0,      "last_status_code": 0,      "last_error": "string",      "next_attempt_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z",      "delivered_at": "2019-08-24T14:15:22Z",      "replay_of": 0    }  ]}
Edit on GitHub