In this tutorial, we will:
- Add an action to your Integry account
- Set it up (like your users would)
- Run it by calling a URL from an HTTP client
It will only take 5 minutes. Let's begin.
Add an action
- Click Add Actions.
- Select an App. In this example, we will select Mailchimp.
- Select one (or more) actions and click Add Action. For instance, we've selected Add Subscriber.
- You can also set the object payload you'll be sending from your app to run this action, or add a tag to group actions, but we'll get to that later.
- You can also set the object payload you'll be sending from your app to run this action, or add a tag to group actions, but we'll get to that later.
- That's it! The action has been added to your account and is ready to use.
- Please refresh the page if it doesn't appear immediately.
Download the embed code
- Click Embed.
- Click Generate Code.
-
-
- You can also filter the actions to be shown, and configure how authentication and execution will work, but we'll get to that later.
- You can also filter the actions to be shown, and configure how authentication and execution will work, but we'll get to that later.
-
-
Setup the action
- Open the downloaded HTML prototype in your browser.
- Click Launch Prototype to open the Actions widget.
- Click an action.
- This is the Actions widget your users will see when you embed it in your app.
- This is the Actions widget your users will see when you embed it in your app.
- Login to the app and authorize Integry to make changes on your behalf.
- You can replace Integry's name on such OAuth screens.
- You can replace Integry's name on such OAuth screens.
- Setup the action and click Save.
- This is how your users will setup an action.
- As you can see, when your users will click a field that is mappable ("Email" in this example), they will be able to select a field from your app's object. Learn more about objects.
- By default, all fields are visible. For a simpler setup experience, you can pre-map and/or hide some of these fields for your users.
- The action is now ready to run!
Run the action
- Copy the callback URL.
- This URL is unique to this instance of this action for your particular user account.
- Instead, if, for instance, you're looking to add App Actions to a workflow builder, you can also let your users create multiple instances.
- Call it from an HTTP client like Postman (or any API client).
- Set method to POST.
- Paste the callback URL in the URL field.
- Copy the object (in this case, it's 'Contact'), and paste that in the 'raw' body.
- Note: Each action is associated to an object. You can customize existing objects or add new ones to represent data in your app. Learn more about objects.
- Click Send to run the action.
- Voila! The action just ran. You can see the synchronous response below. In this case, it failed because Mailchimp doesn't let you use fake-looking email addresses. Let's fix that.
- Edit the Body and replace "johndoe@example.com" with something else like "johndoe@integry.io".
- Click Send to run the action again.
- Great! The action ran successfully. You can see the response below.
- You can now login to the app and see the result. For instance, here's Mailchimp.
That's it! You just added an action to your account, set it up (like your users would), and ran it by calling a unique URL. Put another way, you performed an action with data in another app without having to deal with it's auth, or it's API, in under 5 minutes.
Next, let's embed the Actions widget in your app and so you can run these actions from within your app.
Comments
0 comments
Please sign in to leave a comment.