Create and manage custom apps

A custom app is required to generate an API key in order to use any of Attentive’s APIs. After you’ve generated an API key, you can use the /me endpoint to test that you are authenticating correctly. You should treat your API key as a password and keep it secure. If it is accidentally shared, other users may be able to send messages to customers on your behalf.

After you’ve created a custom app, you can manage your API keys on the App Marketplace page. If you’d like to make your app publicly available for others to use, see Distribute your app.

See the following sections for details:

• Create a custom app
• Edit your custom app
• Regenerate an API key for your custom app
• Delete your custom app

Create a custom app

Complete the following steps to create a custom app for your account:

1. Navigate to the integrations setup page.
2. Click + Create App in the top-right corner.
3. Enter a unique name for your app in the App name field.
4. Enter your email address in the Contact email field.
   This allows Attentive to contact you if there are any issues.

5. Edit the Permissions (No Access or Write) for the following APIs (by default, all APIs have No Access selected):

   • Custom Attributes—Select the permissions for the Custom Attributes API.
   • Custom Events—Select the permissions for the Custom Events API.
   • eCommerce—Select the permissions for the eCommerce API.
   • Privacy Request-Select the permissions for the Privacy Request API.
   • Product Catalog-Select the permissions for the Product Catalog API
   • Subscribers—Select the permissions for the Subscribers API.
6. Click Create.
   The Copy API key modal appears.
   

7. Click Copy to copy the unique API key to your clipboard.

   • Important! This is the only time you will be able to copy this API key.
8. Click X to exit the modal after you’ve saved your API key.

The name and distribution status of your custom app now appear on the App Marketplace page on the Built by you tab.

Edit your custom app

Complete the following steps to edit an existing custom app on your account:

1. Navigate to the integrations setup page.
2. Go to the Built by you tab.
3. Click the name of your custom app.
   Your custom app appears in edit mode.
4. Edit any of the custom app's fields, as necessary.
   Note that the API key is the only field that you can't edit.
5. Click Save.
   The custom app is now updated with your change.

Regenerate an API key for your custom app

Complete the following steps to regenerate an API key for an existing custom app on your account:

1. Navigate to the integrations setup page.
2. Go to the Built by you tab.
3. Click the name of your custom app.
4. Scroll to the API key section and click Regenerate.
   
   The Regenerate API Key? modal appears to confirm that you want to regenerate a new API key for this custom app.
5. Click Yes, regenerate.
   
   The Copy API key modal appears.

6. Click Copy to copy the unique API key to your clipboard.

   • Important! This is the only time you will be able to copy this API key.
     
7. Click X to exit the modal after you’ve saved your API key.

Delete your custom app

Complete the following steps to delete an existing custom app on your account:

1. Navigate to the integrations setup page.
2. Go to the Built by you tab.
3. Click the name of your custom app.
4. Scroll to the bottom of the page and click Delete app.
   The Delete this app? modal appears to confirm that you want to delete your custom app.
   Important! Use caution when selecting this option, as it can't be undone.
5. Enter the name of the app and click Delete.
   
   The custom app is deleted and removed from the App Marketplace page.