The nudge® API allows partners and clients to integrate nudge functionality directly into their own systems and workflows. This article provides a high-level overview of what the API offers. For technical details, see the Preliminary API Integration Instructions article and the detailed API reference.

Sending nudges via the API

There are two patterns for using the API to send push notifications, both covered in detail in API Patterns for Sending nudges. For most use cases, we recommend starting with the Segment-based approach.

Segment-based messaging — Use the Segment and Segment/Members endpoints to programmatically create and populate audience segments. Your system sends us the audience data; nudge's backend takes over all delivery orchestration, including message queuing and capping. The financial institution manages campaigns and messaging content in the nudge portal as usual. This is the recommended pattern for the majority of integrations.

Direct delivery with TriggerNudge — Use the TriggerNudge endpoint to send a push notification directly to a specific user or group of users at the moment your system decides it's time. Your system owns the orchestration; a campaign in the nudge portal serves as the content container and analytics organizer. This pattern is best suited for genuinely time-sensitive, event-driven scenarios where real-time delivery is required.

Other API endpoints

GetOrganization — Returns configuration details for a given nudge client organization. This is particularly useful for partners who are automating their app build process, as it allows them to programmatically determine whether a given client's app should include location-based functionality.

GetJobInfo — Some API calls initiate asynchronous jobs. Use this endpoint to check the status of a previously submitted job and determine whether it has completed successfully.

Getting started

To get started with the nudge® API, email us at support@larky.com. We can walk you through the options that make the most sense for your use case and get you set up with API credentials.