Webhooks
The Webhooks tool enables administrators to create and manage webhooks for order and user events generated by the marketAgility system.
Each webhook listens for a specific event and, when triggered, sends a payload to a defined REST endpoint. This helps keep external systems synchronized with updates made on the website.
Searching for Webhooks
Use the search block to find specific webhooks. To add a new one, click the 'Add Webhook' button.
| Property | Description |
|---|---|
| Name | All or part of the webhook's unique name |
| Event Type | The system event the webhook listens for (e.g., user created, order placed) |
| Environment | Staging or Production |
| Status | Indicates if the task is Active (can run) or Inactive (disabled for both manual and scheduled runs) |
| Actions | Edit / Delete |
Webhook Details
The Details screen allows you to configure webhook settings, including the event trigger, target endpoint, and authentication options.
| Property | Description |
|---|---|
| Name | A unique name to identify the webhook |
| Event Type |
The system event the webhook listens for (e.g., user created, order placed)
|
| Environment | Staging or Production |
| EndPoint |
An endpoint for a webhook is a specific URL where an application or service can send HTTP requests (usually POST requests) to deliver real-time data or notifications from one system to another. In other words, the endpoint is the destination where the webhook payload (the data sent by the webhook) is delivered, allowing the receiving application to process it and trigger actions based on the received information. |
| Format | JSON |
| Username | Username used for Basic Authentication. Sent in the HTTP Authorization header |
| Password | Password used for Basic Authentication. Sent along with the username in the Authorization header |
| Token | Token used for Bearer Authentication. Sent in the Authorization: Bearer header |
| Shared Secret | A secret key used to generate an HMAC-SHA256 hash for security. The hash is sent in the header X-marketAgility-HMAC. The receiving system should validate this to verify the webhook's authenticity. |