Webhooks and API keys in Empower allow you to automate the transfer of your call data to your internal systems, CRMs, and BI tools. In this guide, you will learn how to create and configure a webhook, customize its triggers, and generate secure API keys.
Webhooks and API keys in Empower
1. Access the menu and create a webhook
Access the developer configuration area to add a new endpoint.
- Go to the Settings section of your Empower interface
- In the left menu, click on the Developer option.
- View the list of your existing webhooks or click on Add new.
- Enter the Name of your webhook in the dedicated field
- Enter the Request URL (HTTP endpoint, e.g., https://webhook.site/...) in the URL field. Click on Verify to validate the URL until the "Verified" icon appears.
- Enter a secret token or custom key to secure incoming requests.
2. Configure webhook triggers
Trigger activation
Define the specific events that will trigger the automatic sending of data to your system.
- Enable or disable the toggles according to your call management needs:
- Calls: Triggered when a call is created and processed.
- Tags, Flags, and Notes: Triggered when a tag, flag, or note is added or removed.
- Moments: Triggered when a call moment is added or removed.
- Summary and Call score: Triggered when a call summary or score is modified.
- Framework Analysis: Triggered when a framework analysis is manually updated.
Test the webhook
Simulate sending real data to verify reception of the JSON payload before going into production.
- Click the Test trigger button to simulate the creation and processing of a call.
- Click the Copy payload button to verify the structure of the sent JSON (including call details and evaluation score).
- Once the test is successful, click Save webhook to confirm the configuration.
- The test simulates a POST request with sample data sent to your system to verify successful reception.
- The standard JSON payload sent automatically after a call analysis generally includes the call_details (call identifiers) and the call_score (automated evaluation details).
- Once you have verified the connection and configured your triggers, save the webhook to activate the setup. You can easily delete it later if it is no longer needed.
- Ensure the destination URL is secure (HTTPS).
- Verify that your server is configured to accept POST requests with JSON payloads.
- Always manage the authorization key in your headers to properly filter out unwanted or malicious requests.
Sample Webhook Payload
Here is an example of JSON automatically sent to your webhook after a call analysis:
4. Generate and manage your API keys in Empower
Create API access keys to secure authentication for your third-party applications.
- In the left side menu of the Developer section, click on the API Keys tab.
- Click the Add an API key button
- Enter the API Key Name in the corresponding field.
- Search for and select the associated User from the dropdown menu
- Click Show and then Copy to store your API key in a safe place.
You can modify or revoke an API key at any time by clicking the edit button next to the key in your list
🎉 You now know how to configure webhooks and API keys in Empower and can securely automate the transfer of your call data to your internal tools!