Webhooks
The Webhooks section allows you to enable and manage webhook notifications in ampEducator. When enabled, ampEducator will send event-based notifications to a specified endpoint in your system using the standard webhook format.
Each webhook message includes:
- webhookKey: Unique key for the webhook
- notificationKey: Unique key for the specific notification
- date: UTC timestamp
- type: Webhook type
- dataSignature: HMAC256 hash of the payload
- data: Event-specific payload
To get started, check the Webhooks Enabled box. This will reveal your Secret Key, which is used to sign each webhook notification using HMAC256. You can use this key to validate that the data originated from ampEducator. If needed, you can generate a new secret by clicking Regenerate Key.
Before a webhook URL becomes active, ampEducator will send a challenge request to verify it. Your system must respond with a matching challenge key to complete validation.
For complete technical details and implementation guidelines, visit: https://www.ampeducator.com/api.php#webhooks.
Below the main Webhooks settings, the Webhooks Configured section allows you to create and manage individual webhook endpoints for specific events in ampEducator.
Clicking the New Webhook button opens a configuration modal, where you'll enter the following:
- Webhook Type: Select from a wide range of event triggers.
- Name: A required field to label and identify the webhook.
- Description: An optional note to describe what this webhook is used for.
- URL: The external endpoint that will receive the notification. The URL must begin with https:// and be reachable for validation.
Once completed, click Add & Validate. ampEducator will send a verification request to the provided URL. Only after successful validation will the webhook become active and start sending event notifications to that endpoint.
You can configure multiple webhooks here, each tied to different event types based on your integration needs.