Event types

Parasend sends these events to your webhook endpoints, and lists them at List events. An event is small: it names its type and its resource; fetch the resource for its full state. New types may be added, so ignore types you do not know.

Deliveries

From creation to the end of a delivery.

`delivery.created`	A delivery was created. Its notice goes out next.
`delivery.notified`	The notice went out: the e-mail, the SMS or both. In test mode nothing is sent, but the event still comes.
`delivery.email_opened`	The notice e-mail was opened: the e-mail client loaded its image. A hint, never proof of receipt.
`delivery.opened`	The recipient opened the delivery page through the link.
`delivery.auth_failed`	The recipient tried to verify and failed. `reason` says why, for example `personal_code_mismatch`, `id_document_mismatch`, `timeout` or `cancelled`.
`delivery.confirmed`	The recipient confirmed receipt. This is the event that proves the delivery.
`delivery.downloaded`	The recipient downloaded the documents for the first time.
`delivery.delivered`	The confirmation is sealed into the evidence record: the delivery has reached its end.
`delivery.evidence_sealed`	The evidence record's envelope was sealed, after a request with `sealed=true`.
`delivery.reminded`	A reminder went out, from the follow-up policy or by hand.
`delivery.bounced`	The notice could not be delivered: the e-mail bounced or the SMS failed.
`delivery.expired`	The delivery's time ran out before the recipient confirmed receipt.
`delivery.revoked`	You revoked the delivery before the recipient confirmed receipt.
`delivery.rejected`	A delivery was accepted and then refused before it was sent, by a check that runs after the request. It will not be sent.
`delivery.policy_changed`	The delivery's follow-up policy was changed on its own, not as part of a batch.

Deletion

Data removal.

deletion.scheduled DELETE /deliveries/{id} scheduled the delivery's data for removal.

Documents

What the recipient does with the documents.

document.previewed The recipient previewed a document.

Links

The links in a notice.

link.opened A link in the notice was opened.

One-time codes

SMS codes at the medium level.

`otp.sent`	A one-time code was sent to the recipient by SMS.
`otp.verified`	The recipient entered the right one-time code.
`otp.locked`	Too many wrong codes: one-time codes are locked for the delivery for 24 hours.

Batches

A batch as a whole.

`batch.finalized`	A batch was sent out, or a rolling batch was closed.
`batch.completed`	Every delivery in the batch has reached its end.
`batch.cancelled`	A batch was cancelled: its deliveries that were not yet confirmed are revoked.
`batch.policy_changed`	A batch's follow-up policy was changed.

Link domains

Your own host names for links.

`recipient_domain.verified`	A link domain's DNS records are right, and links can use it. Live mode only.
`recipient_domain.degraded`	A link domain's DNS records are no longer right. Reminders wait for it to work again. Live mode only.
`recipient_domain.failed`	A link domain stayed broken, so links use Parasend's own address. Live mode only.

Members

People in your organisation.

`member.suspended`	A member of your organisation was suspended, from the portal or by SCIM. Live mode only.
`member.restored`	A suspended member was restored. Live mode only.
`member.removed`	A member left your organisation: removed in the portal, by SCIM, or their account was deleted. Live mode only.

E-mail senders

Your own sending address.

`email_sender.verified`	Your e-mail sender's checks passed: notices go from your own address. Live mode only.
`email_sender.degraded`	Your e-mail sender's checks stopped passing for now. Live mode only.
`email_sender.failed`	Your e-mail sender failed: notices go from Parasend's address. Live mode only.
`email_sender.restored`	Your e-mail sender's checks pass again. Live mode only.