Webhooks | Axero Documentation

Enterprise Feature

Webhooks Overview

Webhooks provide a real-time communication mechanism between your platform and external applications. Instead of relying on periodic API polling, webhooks allow automated HTTP requests to be sent to a specified URL when specific events occur. This significantly improves efficiency, reduces API overhead, and enables seamless integration with third-party services.

In Axero, you can configure webhooks to automate actions based on content events, triggered when content is published, updated, expired, or deleted. 

Managing Webhooks

To manage webhooks, navigate to Control Panel > System > Integrations > Webhooks.

Creating and Editing Webhook

To create a new webhook:

1. Navigate to Control Panel > System > Integrations > Webhooks.
   
   

   

2. Click + Add Webhook button to initiate configuration.
3. Add Basic Webhook Information:
   • Webhook Name: Enter a name to easily identify the webhook.
   • Description: Provide a brief description of the webhook’s purpose (optional).
     
     

     

4. Set Integration Settings
   • Target URL: Specify the external endpoint that will receive webhook data. Ensure the URL starts with https://.
   • Headers: Add an API key for authentication.
   • HTTP Method: Webhooks send data using a POST request.
5. Set Event Configurations
   • Space: Select whether the webhook applies to all spaces or a specific one.
   • Event Type: Select Content.
   • Trigger On: Defines when the webhook should activate:
     • Content Published: Triggered when content is published or scheduled.
     • Content Updated: Triggered on any edit (excluding engagement updates).
     • Content Expired: Triggered when content reaches expiration.
     • Content Deleted: Triggered when content is permanently removed.

     

   • Content Types: Choose one or more applicable content types, or Select All to include all content types.
   • Include Fields: Select which content fields should be included in the payload, or Select All to include all fields.

     

6. Webhook Payload Preview

   Before finalizing a webhook, administrators can preview an example of the data payload sent when an event occurs.

   

7. Saving the Webhook

   Once you have completed the configuration steps, click Save as Draft. The webhook will be added to the list in a disabled state. You can enable it and test it later from the configuration page.

   

Volume Management 

You can track how often the selected webhook has been activated over the last 7 days and 24 hours. To view detailed trigger volume details, click the Edit button and navigate to Volume Management.

The Volume Management panel appears when creating a webhook for the first time, so you can anticipate the expected volume and frequency of triggers, helping prevent overload on the site or the external endpoint. It is based on historical data for the selected webhook settings and updates dynamically if you change Spaces, Triggers, or Content Types.

Editing Webhook

To edit an existing webhook, navigate to the Webhooks page and click Edit in the Actions column next to the webhook you want to modify.

The configuration screen will open with the same fields and options used when creating a webhook.

You can change the name, URL, headers, event triggers, or any other settings as needed.

Enabling and Testing Webhook

A newly created webhook is disabled by default. You can test it in this state by clicking the Test button in the Actions column. This sends a sample request to the target URL, simulating an actual event, and is followed by a confirmation message. Test actions are not recorded in the webhook logs. 

After testing, toggle the webhook to enabled. Once enabled, it automatically triggers when the specified event occurs. 

Webhook logs are automatically archived based on global retention policies configured in Log Archive Settings, ensuring past events remain accessible as needed.

Monitoring Webhook Activity

The Last Triggered column provides insight into webhook activity. Each entry includes:

• A timestamp indicating when the webhook last fired.
• The status of the last trigger (Success, Failed, or Pending).
• The event that triggered the webhook (e.g., content.published, content.updated). 

Filtering Webhooks

The Webhook Configurations page displays a list of existing webhooks along with filtering options to narrow them down by:

• Event Type: Specifies whether the webhook is triggered by all system events or only content-related events.

• Triggered On: Allows filtering based on when the webhook was triggered, with options such as Published, Updated, Expired, or Deleted.

• Space: Defines whether the webhook applies to all spaces or a specific one.

• Content Type: Narrows down webhooks based on the type of content they handle, such as articles, albums, or videos.

Webhook Logs

The Logs page provides a complete history of all events where a webhook was triggered, whether it completed successfully or failed. This allows administrators to monitor webhook activity, investigate errors, and retry failed attempts.

Each log entry displays the event timestamp, webhook name, event type, status (Success or Error), and the trigger source. You can view additional information about any entry by selecting View details in the Actions column.

Filtering Logs

The Logs page includes filtering options to help narrow the list of displayed entries based on selected criteria:

• Date Range: Specifies a start and end date to display logs from a specific time period.

• Status: Filters results by All Statuses, Success, or Error.

After selecting your criteria, click Go to refresh the list and update the results.

Log Details

Each log entry includes an option to view detailed information about the webhook event. You can access these details from the Actions column by selecting View details. This helps administrators understand what was sent, how the receiving system responded, and who triggered the event.
The original payload and the response from the destination system are included to support troubleshooting and confirm a successful webhook execution. If the webhook failed, the request can be retried. 

Deleting Webhook

To delete a webhook, click the Delete button in the Actions column.

 A confirmation dialog will appear, requiring you to choose between:

• Keeping the Webhook Name in User Activity and Webhook Logs – The name remains visible in logs even after deletion.
• Redacting the Webhook Name in User Activity and Webhook Logs – The name is removed from logs for privacy.

Deletion is permanent and cannot be undone. Click Delete to confirm or Cancel to return without making changes.