Open Health Sync
Releasesv0.1.0
Api referenceEndpointsAdmin

One delivery with its payload and attempts (instance admin, one tenant)

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

GET /v1/webhooks/{webhook_id}/deliveries/{delivery_id} (getWebhookDelivery) 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
delivery_id*integer

Header Parameters

Authorization*string

The tenant API key, as a bearer secret.

Response Body

The delivery.

application/json
  1. response
id*integer
event_id*string

The webhook-id header and the payload's id.

Formatuuid
event_type*string
status*string

parked after 8 failed attempts (about 28 hours), or when the endpoint was disabled.

Value in"pending""running""done""parked"
attempts*integer
last_status_code*integer|null
last_error*string|null
next_attempt_at*|
Formatdate-time
created_at*string
Formatdate-time
delivered_at*|
Formatdate-time
replay_of*|

The delivery this one replays (same event and payload); null for an original.

payload*

The exact JSON body sent, on every attempt.

attempt_history*array<>

The last 20 attempts, oldest first.

curl -X GET 'http://localhost:8080/v1/admin/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08/deliveries/0' \  -H 'Authorization: Bearer ohs_sk_...'
{  "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,  "payload": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "type": "data.written",    "timestamp": "2019-08-24T14:15:22Z",    "test": true,    "data": {      "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",      "external_ref": "string",      "provider": "string",      "records": {        "property1": 0,        "property2": 0      },      "types": [        "string"      ],      "first_day": "2019-08-24",      "last_day": "2019-08-24",      "records_deleted": 0,      "job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",      "tag_id": "39c8a0b3-fbe8-4801-95bf-e8a0792edf1d",      "categories": [        "activity"      ],      "share_id": "853fa54b-9753-4ffb-b7d0-6739f9ae0f8e",      "expires_at": "2019-08-24T14:15:22Z",      "passcode": true,      "reason": "needs_reauth",      "action": "reconnect",      "retry_at": "2019-08-24T14:15:22Z",      "last_error": "string",      "consecutive_failures": 0,      "previous_reason": "string",      "broken_since": "2019-08-24T14:15:22Z",      "broken_seconds": 0,      "endpoint_id": "e9ce0d4f-d433-423d-9497-4c000544106c"    }  },  "attempt_history": [    {      "id": 0,      "attempt": 1,      "started_at": "2019-08-24T14:15:22Z",      "duration_ms": 0,      "status_code": 0,      "error": "string",      "response_body_excerpt": "string"    }  ]}
Edit on GitHub