Open Health Sync
Releasesv0.1.0
Api referenceEndpointsAdmin

Send a finished delivery's event again, as a new delivery (instance admin, one tenant)

POST
/v1/admin/tenants/{tenant_id}/webhooks/{webhook_id}/deliveries/{delivery_id}/replay

POST /v1/webhooks/{webhook_id}/deliveries/{delivery_id}/replay (replayWebhookDelivery) for the tenant of tenant_id, run with an instance admin key: the same body, parameters and answer as the tenant's own key gets; a Location points at the admin route. 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

Queued. Location is the new 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.

curl -X POST 'http://localhost:8080/v1/admin/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08/deliveries/0/replay' \  -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}
Edit on GitHub