Get Webhook Event Descriptor
GET /v2/ipaas/webhook-events/{type}
Required scopes
ipaas:webhooks:read
Tokens missing any required scope return 401 scope_missing.
See Auth & Scopes for issuance.
Operation
| Operation ID | getWebhookEventDescriptor |
| Tags | Catalog |
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| type * | path | event_type |
Responses
200
OK
object
| Field | Type | Description |
|---|---|---|
| event_type * | event_type | 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 |
| category * | schema | |
| summary * | string | |
| payload_schema * | object | JSON Schema for the payload's typed shape. |
| fires_on * | string | |
| resource_type | string | |
| required_subscribe_scope * | string | |
| notes | string |
Example request
GET https://api.digitalonboarding.com/v2/ipaas/webhook-events/{type}
Authorization: Bearer <partner-token>