Notifications

ReceiptHero delivers webhook notifications on receipt and payment transaction arrival, as well as connection revoke events.

Types

Partner application can receive 3 types of notifications:

Transaction notification

This notification is delivered immediately when ReceiptHero receives information about the upcoming receipt. Name of the Merchant is included in the notification payload.

Receipt notification

This notification is delivered immediately when the receipt is ready for fetching. The notification includes a receipt id for the receipt to fetch.

Connection revoke notification

This notification is delivered when a connection revoke is initiated from the ReceiptHero system.

Webhook Request

POST <WEBHOOK_PATH> HTTP/1.1
Host: <WEBHOOK_HOST>
Authorization: Token <API_KEY>
Content-Type: application/json

Webhook Payload

Examples

Receipt notification
{
  "notification_type":"receipt_notification",
  "receipthero_id":"7350515d-0f15-4663-8430-cf4d7f4057a1",
  "receipt_id":"93d22d66-f4bd-11e8-8eb2-f2801f1b9fd1",
  "partner_metadata": {
    "key1": "value1",
    "key2": "value2"
  }
}
Transaction notification
{
  "notification_type":"transaction_notification",
  "receipthero_id":"7350515d-0f15-4663-8430-cf4d7f4057a1",
  "receipt_id":"93d22d66-f4bd-11e8-8eb2-f2801f1b9fd1",
  "data": {
    "merchant_name": "ReceiptHero Oy"
  },
  "partner_metadata": {
    "key1": "value1",
    "key2": "value2"
  }
}
Connection revoke
{
  "notification_type":"oauth_authorization_revoke",
  "receipthero_id":"7350515d-0f15-4663-8430-cf4d7f4057a1",
  "partner_metadata": {
    "key1": "value1",
    "key2": "value2"
  }
}

Fields

ParameterValueExplanation

notification_type

receipt_notification | transaction_notification | oauth_authorization_revoke

Notification type

receipthero_id

uuid

User uuid

receipt_id

uuid

Receipt uuid

data

object

Additional data (Transaction notifications only)

partner_metadata

object

Partner defined connection-specific key-value pairs. See also: Get an authorization code step in OAuth 2 flow

Last updated