Last updated 2 minutes ago

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 in the Manage Custom Apps 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

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

  1. Navigate to the integrations setup page.
  2. Click Manage Custom Apps in the top-right corner.
  3. Click Create App in the top-right corner.
  4. Enter a unique name for your app in the App name field.
  5. Enter your email address in the Contact email field. This allows Attentive to contact you if there are any issues.
  6. Edit the Permissions (No access, Read, or Write) for the following APIs (by default, all APIs have None selected):

    • eCommerce—Select the drop-down in the Permissions column to select the permissions for the eCommerce API.
    • Custom Events—Select the drop-down in the Permissions column to select the permissions for the Custom Events API.
    • Subscribers—Select the drop-down in the Permissions column to select the permissions for the Subscribers API.
    • Custom Attributes—Select the drop-down in the Permissions column to select the permissions for the Custom Attributes API.
  7. Click Create. The Copy API Key modal appears.
  8. 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.
  9. Click X to exit the modal after you’ve saved your API key.

The name and Distribution Status of your custom app now appears on the Manage Custom Apps page. Your custom app appears on the Integrations tab in the Built by you section.

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. Click Manage Custom Apps in the top-right corner.
  3. Click the name of your custom app. Your custom app appears in edit mode. Note that the API Key is the only field that cannot be edited.
  4. Edit the following fields for the custom app:

    • App name
    • Contact email
  5. Click Upload app icon to upload your organization’s icon for the app.

    • Note: You can upload a 256 x 256 pixel PNG or JPG. This icon appears throughout Attentive and represents your app visually.
  6. Edit the Permissions for each API.
  7. 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. Click Manage Custom Apps in the top-right corner.
  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 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. Click Manage Custom Apps in the top-right corner.
  3. Click the name of your custom app.
  4. Scroll to the Delete App section and click Delete.

    The Delete App modal appears to confirm that you want to delete your custom app.
  5. Click Delete. The custom app is deleted and removed from the Manage Custom Apps and Integrations pages.