Introduction
Changelog
Authentication
Headers
Errors
Rate Limiting
Webhooks
CDR
OAuth 2.0
User
Devices
Addresses
Affordability
Aggregation
Bills
Budgets
Cards
Challenges
CDR
Configuration
Contacts
Events
Goals
KYC
Managed Products
Messages
Pay Day
PayID
Payments
Reports
Statements
Surveys
Calculators
Images
Users
Accounts
Transactions
Financial Passport
Status
Outages
Banking
Common

Events

Events in the Frollo platform are triggered when certain things happen and can be used to automate various actions. Events typically will trigger messages which represent things like emails, in-app messages or webhooks.

For example an event may fire when a user exceeds their budget and triggers a push notification for the user. Or an event may trigger a webhook when enriched transaction information has become available.

Message Types

There are a number of message types that can be triggered by events. Usage of these will depend on the event and the action desired.

Email

If you have an external email service configured in your tenant this message type can be used to trigger email campaigns and templates.

Messages

Messages are objects that can then be fetched using the Messages endpoint on the Client API. This is typically how in-app messages can be triggered and presented to the user. There are a few pre-determined types that can be used:

  • Text and Image - Allows you to render your own message using basic text and imagery. The design_type field can be used to allow different rendering templates to be used
  • Image - Simple images can be presented
  • Video - Video content can be displayed along with some options to determine how the client should present the video
  • HTML - Custom HTML content can be pushed allowing full flexibility to get the message design you need or even test new designs

Push Notifications

Push notifications can be triggered directly from the portal for both Android and iOS if configured. This can be used for whitelabel apps or as an alternative to using an external tool to trigger push notifications.

To use a custom push notification service Webhooks can be used to trigger your own integration.

Webhooks

Webhook messages provide the most flexibility as they contain the raw event data and parameters. These will be sent to your Webhook Events endpoint and can then be used to build your own messages or integrate with your own CRM system.

Additionally these events are needed to trigger certain business logic such as fetching updated transactions when a T_UPDATED event is received or respond to a CDR consent expiring if a CONSENT_STOPPED event is received.

Chaining

Custom events can be created and then used to chain events together. For example the User Registration event U_REGISTERED could have an onboarding journey chained to it to help the user become acquainted with the PFM features.

Event Groups

There are number of groups of events which may be of use to you.