The following data collection process events can be subscribed to by your application.
| Event code | Description |
|---|
| dc_email_delivered | Occurs when an email has been delivered to a recipient email server who is completing a data collection process |
| dc_recipient_first_opened | Occurs when a recipient has first opened their data collection process |
| Field | Type | Description |
|---|
| id | string (uuid) | See How do I secure my notification URL? |
| alg | string | See How do I secure my notification URL? |
| sentAt | date (ISO 8601-1:2019) | When the notification was sent |
| event | string | "dc_email_delivered" |
| email_event | string | See remarks |
| email_id | string | The email message ID |
| email_recipient_smtp | string | The recipient SMTP email address |
| recipient_id | string (uuid) | The recipient ID |
| recipient_reference | string | Optional. Round-trip reference of the recipient originally supplied by you |
| file_id | string (uuid) | File UUID |
| file_reference | string | File reference of the the file |
| Event code | Description |
|---|
| dc_invite | An invitation email to begin a data collection process. The event can be re-raised if the invite email is sent again, the recipient email address changed or if the file is re-issued. |
| Field | Type | Description |
|---|
| id | string (uuid) | See How do I secure my notification URL? |
| alg | string | See How do I secure my notification URL? |
| sentAt | date (ISO 8601-1:2019) | When the notification was sent |
| event | string | "dc_recipient_first_opened" |
| recipient_id | string (uuid) | The Finch recipient ID who first opened |
| recipient_reference | string | Optional. Round-trip reference of the recipient originally supplied by you |
| file_id | string (uuid) | File UUID |
| file_reference | string | File reference of the the file |
