Get Webhook Delivery
GET /v2/ipaas/webhook-deliveries/{id}
Required scopes
ipaas:webhooks:read
Tokens missing any required scope return 401 scope_missing.
See Auth & Scopes for issuance.
Operation
| Operation ID | getWebhookDelivery |
| Tags | Deliveries |
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| id * | path | id |
Responses
200
OK
object
| Field | Type | Description |
|---|---|---|
| id * | string (uuid) | UUID v4. |
| type * | enum (1) | webhook_delivery |
| subscription_id * | id | UUID v4. |
| event_id * | id | UUID v4. |
| event_type * | enum (37) | 37 typed events per 03-ipaas.md §5.4 (session-6 additions: sftp.file_arrived, incoming_webhook.received, webhook.incoming_receiver_disabled, webhook.incoming_receiver_signature_failure_threshold_reached).contact.createdcontact.updatedcontact.deletedcontact.unsubscribedcontact.resubscribedjourney.createdjourney.completedjourney.reached_deadlinejourney.cancelledjourney.engagement_state_changedobjective.completedmessage.scheduledmessage.dispatchedmessage.deliveredmessage.bouncedmessage.openedmessage.clickedmessage.failedengagement.page_viewedengagement.page_engagedengagement.widget_actioncampaign.launchedcampaign.pausedcampaign.resumedcampaign.archivedcohort.materializedcohort.materialize_failedbatch.acceptedbatch.succeededbatch.partially_failedbatch.failedwebhook.subscription_disabledwebhook.subscription_dead_letter_threshold_reachedsftp.file_arrivedincoming_webhook.receivedwebhook.incoming_receiver_disabledwebhook.incoming_receiver_signature_failure_threshold_reached |
| payload * | object | Discriminated union over `event_type`. See `03-ipaas.md` §6 for per-event typed shapes. |
| status * | enum (4) | pendingsucceededfaileddead_lettered |
| attempts * | object[] | |
| occurred_at * | string (date-time) | RFC 3339 / ISO 8601 timestamp. |
| delivered_at | occurred_at | RFC 3339 / ISO 8601 timestamp. |
| last_attempted_at | occurred_at | RFC 3339 / ISO 8601 timestamp. |
| next_attempt_at | occurred_at | RFC 3339 / ISO 8601 timestamp. |
Example request
GET https://api.digitalonboarding.com/v2/ipaas/webhook-deliveries/{id}
Authorization: Bearer <partner-token>