Data Management: API Keys and Webhooks

The Data Management tool in the Engagement Rx admin system is where administrators can manage API Keys and WebHooks for their organization. This guide will walk you through the steps to create a new WebHook.

Accessing the Data Management Tool

From the Engagement Rx admin dashboard, go to the Settings section and enter the Data Management module:

On this page you will see two main sections:

1. API Keys
2. WebHooks

API Keys Section Overview

In the API Keys section, you’ll find a table listing all API keys associated with your company. Each entry in the table displays:

1. Name: A unique identifier for the API key.
2. Portal: The specific portal where the API key is used.
3. Date Created: The date the API key was generated.

Steps to Create an API Key

1. Above the API keys table, click the Create button.
2. In the Create API Key form, enter the following details:
   • Name: Provide a descriptive name for the API key (e.g., "Client Integration Key") to easily identify its purpose.
   • Portal: Select the portal where the API key will be used. This determines which areas or functions of Engagement Rx the key will apply to.
3. After entering the required information, click Create to generate the API key.
   • Important: A message will appear with your newly generated API Key and API Secret. For security purposes, these details will be displayed only once. You must:
     • Click Copy API Key to copy the API key.
     • Click Copy API Secret to copy the API secret.
     • Ensure you securely store both the key and secret immediately in a safe location (e.g., a password manager or secure environment variables).
   • If you fail to copy and store the API key and secret, you will need to regenerate a new set, as these details cannot be retrieved later.
4. Once saved, the API key will be listed in the table with its name, portal, and creation date.

Both the API key and secret should be handled carefully and kept secure, ensuring they are only shared with authorized personnel.

Best Practices for API Key Usage

• Security: API keys should be securely stored in a protected system, such as environment variables, and should never be hard-coded into an application’s source code.
• Key Rotation: It’s good practice to periodically regenerate API keys to ensure continued security, especially if there is a risk of exposure.

WebHooks Section Overview

In the WebHooks section, you'll find a table listing all WebHooks associated with your company. The table columns display the following information:

1. Actions: Edit, test, or delete a webhook
2. Name: The name of the WebHook
3. Endpoint: The client URL where the WebHook will post data.
4. Portal: The specific portal where the WebHook is active or All Portals.
5. Date Created: When the WebHook was initially set up.

Steps to Create a WebHook

1. Above the WebHooks table, click the Create button.
2. In the Create WebHook form, you will need to provide:
   • Name: A unique identifier for the WebHook.
   • Endpoint URL: Your HTTPS URL where events will be posted.
   • Portal: Select the portal that the WebHook will apply to.
3. After entering the necessary information, click Create to finalize your new WebHook.

Once created, the WebHook will appear in the table with its relevant details.

Additional Notes

1. Ensure that your Endpoint URL is correctly configured to handle the incoming WebHook events.
2. Testing a new WebHook (from the actions menu) prompts Engagement Rx to send a simulated Webhook event to your endpoint URL to ensure everything is working properly.