Add custom apps

With Custom Apps, you can integrate with an app other than the pre-built integrations that Blueshift offers. Using Custom Apps, you have the flexibility to integrate with an app that supports Rest APIs or webhooks, without any additional coding.

Prerequisites

Depending on the type of authentication required for the custom app, the following information is required for integration with Blueshift:

• The API key provided by the custom app.
• The API username and API password to access the APIs for the custom app.
• OAuth2.0 information for the custom app.

Set up a custom app in Blueshift

To add and use a custom app in Blueshift campaigns, complete the following steps:

1. Add a custom app.
2. Add an adapter for the custom app.
3. Use the Cloud App Studio to add a Cloud App template to send a message. You can add a template only if you have at least one adapter configured for the custom app.

   You can now use the custom app in a campaign.

Add a custom app

To add a custom app, complete the following steps:

1. Go to App Hub > My Apps and click +ADD CUSTOM APP.

   

2. Provide a Name for the app and add a Description.
3. Specify the Type of Authentication. You can select from None, API Key, Basic HTTP, and OAuth 2.0.
4. If you select OAuth 2.0 as the Type of Authentication, you must specify the Grant Type. You can select from Authorization Code, Client Credentials, Implicit, or Resource Owner Credentials.

   Note: If you are using OAuth 2.0 for authentication, you must set the Redirect URL as https://app.getblueshift.com/api/v1/account_app_profiles/oauth_callback.

5. Add any Additional Headers as required.
6. Upload a logo for the app.
7. Click Save.

   The custom app is created.

   To edit the app, click Edit Custom App.

Add an adapter for the custom app

After you configure your custom app, you must add an adapter for the app. An adapter includes app level configuration details, such as authentications and permissions. The information you need to provide depends on the type of authentication that you have selected for the custom app. After you add the adapter, you can use it in a Cloud App template.

Note: The API endpoint for the custom app adapter is set on the Properties tab of the Cloud App template that you create to send the message.

To add an adapter, complete the following steps:

1. Open the custom app and click +ADAPTER.
2. Provide the authentication information:

   Type of authentication	Details to provide
   API Key	API key: The API key provided by the custom app.
   Basic HTTP	API username: The username to access the APIs for the custom app. API password: The password to access the APIs for the custom app.
   OAuth 2.0: Authorization Code	Base URL: The base URL for the custom app. Login URL: The URL to log into the custom app. Sub-domain: The sub domain for your account in the custom app. Client ID: The Client ID provided by the custom app. Client Secret: The Client Secret provided by the custom app.
   OAuth 2.0: Client Credentials	Sub-domain: The sub domain for your account in the custom app. Client ID: The Client ID provided by the custom app. Client Secret: The Client Secret provided by the custom app.
   OAuth 2.0: Resource owner credentials	Client ID: The Client ID provided by the custom app. Client Secret: The Client Secret provided by the custom app. API username: The username to access the APIs for the custom app. API password: The password to access the APIs for the custom app.

3. Provide the information for any Additional headers.
4. Click Save.

Next steps

1. Add a Cloud App template by clicking +TEMPLATE. You can add a template only if you have at least one adapter configured for the custom app.
2. Verify the integration by doing a test send from the template.
3. Use the custom app in a campaign.

Use the custom app in a campaign

When you create a campaign and add a trigger, select the name of the custom cloud app as the channel for the trigger.