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
Webhook Payload
Examples
Fields
Parameter | Value | Explanation |
---|---|---|
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