Integrations enable two or more apps to interact with each other, creating additional value for users. This guide will help you build your first integration at Steady.
The components of an Integration
Integrations are represented by a set of actions or processes between different apps, organized into a flow.
ntegrations are represented by a set of actions or processes between different apps, organized into a flow.
Components of a Flow:
1. Source:
The starting point of a flow, triggered by an event.
A Source could be activated by: A Webhook API call, a Schedule run, or manual execution.
2. Event:
When a Source is triggered, an Event is created. Events carry the payload data received from the Source.
3. Destination:
Actions that follow the trigger. Each Destination belongs to a Source and listens for its Events.
When a Source has a new Event, all subscribing Destinations will act on it: a "Message" is created for each.
4. Message:
A combination of the Event’s payload and the Destination’s Target URL.
After created, the Message will send a request to the Destination’s Target URL with the Event’s payload. This action creates an "Attempt".
5. Attempt:
Every time a Message is fired, it generates an Attempt. Attempts can either be successful or failed.
Now let's go step-by-step to create a flow:
1. Set up a source
Create a source by clicking the Plus button on the Navigation ba
Once created, you will see a Webhook, send a test request to the Webhook API
After sending a request, the events count increases one, Click on the "view" button to see
2. Create a destination
To create a Destination, in the Source's details page, scroll down to the "Destinations" section. Click the "Create" to start setting up a new destination.
After created, select a pilot event for the destination, you can selected an existing event from the subcribed Source, or select an event template.
After selecting an pilot event, you can specify how the payload in the Pilot Event should be transformed. At this step, you also need to define how to send the payload to a target URL. You can open the "Templates" and select one of our baked templates to speed up the development process.
After setting up the transformer, you can preview how the payload looks like, after applying the transformer rules to the Event's payload, and then send a test request to the target URL. Click on the "Preview" Button to show the preview popup.
After testing successully, click on the "activate" button. Now, your first ever flow at Steady are finish and fully automated.
From now, any incoming events to the Source will be processed by the Destination's setup.
