Get Engagement Event
GET /v2/partner/engagement-events/{id}
Required scopes
partner:engagement:read
Tokens missing any required scope return 401 scope_missing.
See Auth & Scopes for issuance.
Operation
| Operation ID | getEngagementEvent |
| Tags | Engagement |
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| id * | path | id |
Responses
200
OK
object
| Field | Type | Description |
|---|---|---|
| id * | id | UUID v4. |
| type * | enum (1) | engagement_event |
| team_id * | id | UUID v4. |
| contact_id * | id | UUID v4. |
| journey_id | string (uuid) | |
| template_id | string (uuid) | |
| message_id | string (uuid) | |
| page_id | string (uuid) | |
| content_block_id | string (uuid) | |
| event_type * | enum (14) | email_deliveredemail_openedemail_bouncedemail_unsubscribedsms_deliveredsms_failedsms_clickedpush_deliveredpush_openedmessage_clickedpage_viewedpage_engagedwidget_actionobjective_completed |
| payload * | oneOf<object | object | object | object | object | object | object> | |
| occurred_at * | updated_at | RFC 3339 / ISO 8601 timestamp. |
| client_reported_at | updated_at | RFC 3339 / ISO 8601 timestamp. |
| inserted_at * | updated_at | RFC 3339 / ISO 8601 timestamp. |
Example request
GET https://api.digitalonboarding.com/v2/partner/engagement-events/{id}
Authorization: Bearer <partner-token>