Webhook Management & Event Webhooks
What's New?
You now get a full API toolkit to monitor, inspect, and replay your webhook deliveries, plus several new event webhooks that let you track your data. Read delivery health on any subscription, list and inspect every send, and replay a failed send.
These workflows are available via the API as described below and the Backoffice interface. For those working in the UI, see Manage Webhook Subscriptions.
API additions
New endpoints
| Resource | Endpoint | Purpose |
|---|---|---|
| Webhooks | GET Review Recent Work Item Events | List send attempts for a subscription. |
| Webhooks | POST Replay a Webhook Send | Resend a payload to its original destination. |
| Webhooks | DELETE Delete a Webhook Subscription | Remove a subscription. |
| Event Center | GET Review Recent Work Item Events | List recent work item events. |
| Event Center | GET Review a Work Item Event by ID | Read a single event. |
Updated endpoints
The Subscribe, Update, and Delete subscription endpoints now accept an X-Initiated-By header. WebhookSubscriptionResponse adds two fields tracking the most recent send:
| Field | Type | Description |
|---|---|---|
isHealthy | Boolean (nullable) | Whether the most recent send from this subscription succeeded. null until the first send. |
lastSendDate | DateTime (nullable, ISO 8601) | Timestamp of the most recent send. null until the first send. |
Reviewing and replaying sends
GET .../sends returns each attempt with the fields below. It supports pagination and date filtering using the same query parameters as elsewhere in the API, but does not return pagination metadata in the response. The replay endpoint returns a CommandInfoResponse, like our other asynchronous POST endpoints. Webhook actions are also recorded in the Event Center (a 24 hour log) and available over the API for seven days.
| Field | Type | Description |
|---|---|---|
id | Integer | Unique ID of the send. |
subscriptionId | Integer | Subscription the send belongs to. |
webhookFingerprint | String | Shared across retry attempts of the same payload. |
body | String | The JSON payload that was sent. |
destinationURL | String | The endpoint the payload was delivered to. |
error | String | The error returned by your endpoint, or null on success. |
isSuccess | Boolean | Whether the send succeeded. |
sentDate | DateTime | When the send was attempted. |
Infiniport webhooks for end-to-end visibility
For clients using Infiniport, we've published the following webhooks so you can track your data as it moves through Infinicept. NOTE: These events currently fire only for transactions imported through Infiniport. They do not fire for transactions imported by other methods.
These values are now defined on BackofficeWebhookType:
| Value | Event | Fires when |
|---|---|---|
2 | DataFileAcceptedForProcessing | A data file you or your processor sent is received and queued. |
3 | DataFileProcessed | A data file finishes processing, reporting rows imported, merchants affected, and any validation errors. |