Skip to main content
WEBHOOK
summary.document.report.updated
{
  "type": "<string>",
  "timestamp": "2023-11-07T05:31:56Z",
  "data": {
    "id": 123,
    "documentId": 123,
    "companyId": 123,
    "eventId": 123,
    "length": "line",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "previousAttributes": {
    "id": 123,
    "documentId": 123,
    "companyId": 123,
    "eventId": 123,
    "length": "line",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
x-api-key
string
header
required

Headers

​
Webhook-Id
string
required

A unique message identifier for the webhook.

​
Webhook-Timestamp
string
required

The time the message was generated (Unix timestamp in seconds).

​
Webhook-Signature
string
required

A cryptographic signature that allows you to verify the integrity and authenticity of the payload.

Body

application/json
​
type
string
required

The type of event.

Allowed value: "summary.document.report.updated"
​
timestamp
string<date-time>
required

The time the event was triggered.

​
data
object
required

On update, contains the updated details.

​
previousAttributes
object
required

Only the properties that changed.

Response

200

Webhook received successfully