Plum / developers
REST APIEvents

Get endpoint delivery details

GET/endpoints/{id}/deliveries/{delivery_id}

Authorization

bearerAuth
AuthorizationBearer <token>

Send Authorization: Bearer <token> with one of: an app session access token from /auth/verify-otp or /auth/refresh; an OAuth access token from /oauth/token issued for the API origin (its scopes are its permissions); or a personal access token starting with optima_pat_ (see /docs/personal-access-tokens). Personal access tokens cannot create or list tokens, revoke other tokens, sign out, or delete or restore the account. Content routes need the permission of their layer: audio:read/audio:write for recordings, turns:read/turns:write for turns, contacts, source signals, and events, and insights:read/insights:write for suggestions and session summaries; search and recall need turns:read and insights:read. A request without the permission, or for an account whose layer is turned off, returns 403 FORBIDDEN. See /docs/authentication#scopes.

In: header

Path Parameters

id*string
Formatuuid
delivery_id*string
Formatuuid

Header Parameters

X-API-Version?"1"

Send 1 to pin the documented API contract. If omitted, the latest version is selected.

Default"1"

Value in

  • "1"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/endpoints/497f6eca-6276-4993-bfeb-53cbbbba6f08/deliveries/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "X-API-Version: 1"
{  "success": true,  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "endpoint_id": "e9ce0d4f-d433-423d-9497-4c000544106c",    "event_id": "a7a26ff2-e851-45b6-9634-d595f45458b7",    "status": "pending",    "attempts": [      {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "delivery_id": "9892f438-d31c-4ff2-bc84-146525b292ff",        "attempt_number": 1,        "started_at": "2019-08-24T14:15:22Z",        "finished_at": "2019-08-24T14:15:22Z",        "status_code": 0,        "error": "string",        "duration_ms": 0      }    ],    "next_attempt_at": "2019-08-24T14:15:22Z",    "created_at": "2019-08-24T14:15:22Z",    "delivered_at": "2019-08-24T14:15:22Z",    "last_error": "string",    "event": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "schema_version": 1,      "sequence": "string",      "occurred_at": "2019-08-24T14:15:22Z",      "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",      "data": {        "changed_fields": [          "string"        ],        "pipeline_id": "ec036e81-7903-4e4d-bbfa-ac8516341cf0",        "source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",        "run_id": "dded282c-8ebd-44cf-8ba5-9a234973d1ec",        "revision": 1,        "state_version": 1,        "reason": "string"      },      "type": "workspace.deleted",      "resource": {        "type": "workspace",        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"      }    }  }}