Skip to content

Journal Entry document attached
Alpha
Webhook

Request

Sent when a supporting document - such as a customer receipt or credit note - is attached to an existing journal entry. Documents can be attached after the entry was first recorded, so re-fetch the entry to pick up the newly attached document.

Headers
webhook-idstringrequired

Unique identifier for this webhook message. This ID is the same when a webhook is retried due to a previous failure. Use this for deduplication.

webhook-timestampstringrequired

Timestamp of when the webhook was sent, in seconds since epoch. Compare against your system time to prevent replay attacks.

webhook-signaturestringrequired

Base64-encoded HMAC-SHA256 signature for verifying the webhook authenticity. The signature is computed over: {webhook-id}.{webhook-timestamp}.{body}.

Bodyapplication/jsonrequired

The journal entry and document IDs for lookup.

idstringrequired

Unique identifier for the event.

typestringrequired

The event type.

Value:"v1.journal_entry.document_attached"
timestampstring, (date-time)required

Timestamp of when the event occurred.

payloadobject(JournalEntryDocumentAttachedEventV1)required

The event-specific payload data.

POST
v1.journal_entry.document_attached
Payload
{
  "id": "string",
  "type": "v1.journal_entry.document_attached",
  "timestamp": "2019-08-24T14:15:22Z",
  "payload": {
    "id": "string",
    "host_id": "string",
    "document_id": "string"
  }
}

Responses

OK