The Call an API action in Architect sends an HTTP request to an external endpoint at a defined point in a journey. You can use it to trigger webhooks, push data to a CRM, or invoke any third-party service your workflow depends on.
More specifically, you can use Call an API to:
Provide other systems and applications with real-time information.
Send information to systems such as Salesforce or SMS and Email Vendors.
Send information to your backend systems.
For example, you might want to add credit or a promotion to your customer's account once they’ve performed a specific event a certain number of times. You can use Call an API to do this.
Call an API is the process of sending a request to a defined outsourced tool or vendor system with a defined payload by using the Call an API element in a journey. When the request is successfully sent and a success response is received, the request is successful and the success count increments by one. If the request fails, then the fail count will increment by one. In either case, the user proceeds to the next step in the flow.
To send data to the Insider database, you can send it via the Upsert API.
To trigger a 3rd party tool through the journey based on the user’s action, you can use Call an API.
Call an API is not a bulk data sending tool. If you want to export bulk user data, you can export it via the Raw Data Export API.
Integrate Call an API
To add an outsourced provider to your journeys, you need to:
Have an up-and-running API for the respective provider that is ready to use,
Fulfill all the conditions for a JSON POST request inside the Call an API element in your journey.
In case you want to whitelist Insider's API call IP address for security reasons, you can use the following IP addresses:
52.213.194.109
52.19.197.71
3.248.68.7
IP whitelisting works for the Test API option.
If you plan to send an email or SMS via Call an API, you need to provide Insider with the required user information, such as the email address and sms_optin. You can pass this data to Insider using the data ingestion methods.
Next, you can read: