Introduction
Changelog
Usage
Authentication
Headers
Errors
Rate Limiting
Webhooks
OAuth 2.0
User
Devices
Aggregation
Bills
Budgets
Challenges
CDR
Configuration
Contacts
Events
Goals
Messages
Pay Day
Payments
Reports
Surveys
Calculators
Images
Financial Passport
Users
Accounts
Transactions

Webhooks

Webhooks allow the Frollo platform to provide realtime notifications, messaging and events back to your integration platform. By providing a webhook endpoint events and payloads can be sent when events occur in Frollo in realtime.

Here are some examples of webhook usage:

  • Data availability - notifications that new data is available, e.g. new CDR data has been retrieved
  • Transaction enrichment - events fired when bulk loads of transactions have been successfully categorised and enriched
  • Messaging - provide the raw data to drive your own email or notification content using your CRM platform

Endpoint

To consume Frollo webhooks you must provide a secure endpoint that webhooks can call. Data provided to this endpoint is in the format of an event and complimentary payload of properties that are related to the event.

Example payload:

{
  "common": {
    "eventKey": "T_UPDATED",
    "state": "triggered",
    "userId": 123,
    "accountId": 456,
    "externalUserId": "AD9F787C-1CA1-41C1-9D03-C98A914D6DA8",
    "userEventId": 789,
    "firstName": "Edd"
  },
  "payload": {
		"TRANSACTION_IDS": [1, 2, 3]
	}
}

The specification for webhook payloads is documented at Webhooks Events API.

Authentication

To provide security around calling this endpoint with potentially sensitive data Frollo can support OAuth2.0 using the Client Credentials grant to authenticate with your endpoint. Client Credentials are configured using the Admin Portal on your tenant.

Example authorization header:

Authorization: Bearer xxx.yyy.zzz