Orvelt

link.created

A delivery link was created for a customer.

Payload version 3. data is a snapshot of the resource after the change.

Request Body

The Standard Webhooks envelope Orvelt sends to your destination.

application/json
  1. body
id*string

The event ID. A retried delivery keeps it, so deduplicate on it.

Formatuuid
type*"link.created"

The event topic.

Value in"link.created"
timestamp*string

When the change happened.

Formatdate-time
data*

Response Body

Acknowledge the event. Any other status, or no response in time, is retried.

Example Requests
POST/link.created
Request Body
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "type": "link.created",
  "timestamp": "2019-08-24T14:15:22Z",
  "data": {
    "verificationId": "string",
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "customerEmail": "string",
    "customerFirstName": "string",
    "customerLastName": "string",
    "customerReference": "string",
    "status": "issued",
    "responseId": "ed662de2-39c1-4e7d-a6bf-6980511adfaf",
    "issuedAt": "2019-08-24T14:15:22Z",
    "expiresAt": "2019-08-24T14:15:22Z",
    "emailedAt": "2019-08-24T14:15:22Z",
    "clickedAt": "2019-08-24T14:15:22Z",
    "submittedAt": "2019-08-24T14:15:22Z"
  }
}