Get Event With Deliveries

GET

/api/:account_id/events/:external_id/full

GET

/api/:account_id/events/:external_id/full

$ curl https://app.paymentkit.com/api/account_id/events/external_id/full \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

1 {
2   "event": {
3     "id": "evt_9f8b7c6d5a4e3f21",
4     "type": "payment.succeeded",
5     "aggregate_type": "payment",
6     "aggregate_id": "pay_1234567890abcdef",
7     "data": {
8       "amount": 1500,
9       "currency": "USD",
10       "status": "completed",
11       "customer_id": "cus_9876543210fedcba"
12     },
13     "metadata": {
14       "source": "web",
15       "campaign": "spring_sale"
16     },
17     "version": 3,
18     "created": "2024-01-15T09:30:00Z",
19     "previous_data": {
20       "status": "pending"
21     },
22     "correlation_id": "corr_abc123xyz789",
23     "actor_type": "user",
24     "actor_id": "user_42",
25     "actor_email": "jane.doe@example.com",
26     "actor_name": "Jane Doe",
27     "actor_display": "Jane D.",
28     "actor_origin": "dashboard",
29     "actor_reason": "manual override"
30   },
31   "deliveries": [
32     {
33       "id": "deliv_0011223344556677",
34       "event_id": "evt_9f8b7c6d5a4e3f21",
35       "webhook_endpoint_id": "wh_123abc456def7890",
36       "status": "delivered",
37       "attempt_count": 2,
38       "created": "2024-01-15T09:30:05Z",
39       "webhook_endpoint_url": "https://webhooks.example.com/payment",
40       "last_attempt_at": "2024-01-15T09:32:00Z",
41       "delivered_at": "2024-01-15T09:32:00Z",
42       "next_retry_at": null,
43       "response_status": 200,
44       "error": null
45     },
46     {
47       "id": "deliv_889900aabbccddeeff",
48       "event_id": "evt_9f8b7c6d5a4e3f21",
49       "webhook_endpoint_id": "wh_987zyx654wvu3210",
50       "status": "failed",
51       "attempt_count": 3,
52       "created": "2024-01-15T09:30:10Z",
53       "webhook_endpoint_url": "https://hooks.anotherexample.com/events",
54       "last_attempt_at": "2024-01-15T09:35:00Z",
55       "delivered_at": null,
56       "next_retry_at": "2024-01-15T09:40:00Z",
57       "response_status": 500,
58       "error": "Internal Server Error"
59     }
60   ],
61   "suppressed_endpoints": [
62     {
63       "id": "wh_suppressed_001",
64       "url": "https://suppressed.example.com/webhook",
65       "consecutive_failures": 5,
66       "blacklisted_at": "2024-01-10T08:00:00Z"
67     }
68   ]
69 }

Get an event with all its delivery statuses. Combines event data with webhook delivery information in a single response.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

external_idstringRequired

account_idstringRequired

Response

Successful Response

eventobject

Event response schema. Represents a persisted domain event for API responses.

deliverieslist of objects

suppressed_endpointslist of objectsOptional

Errors

422

Unprocessable Entity Error