Aimfox icon

Aimfox

Interact with Aimfox application

Actions48

Webhook → Create Webhook

AI-generated

Overview

This node operation allows users to create a webhook in the Aimfox application. It is useful for scenarios where you want to receive real-time notifications or data updates from Aimfox by specifying an endpoint URL that will receive webhook payloads triggered by selected events. For example, you can create a webhook to get notified when a campaign is created or when a new connection is made.

Use Case Examples

  1. Create a webhook named 'My Webhook' that listens to 'Campaign Created' and 'New Connection' events and sends payloads to https://example.com/webhook.
  2. Set up a webhook to monitor 'Account Logged In' events for integration with another system.

Properties

Name Meaning
Webhook Name The name of the webhook to be created, used for identification.
Webhook URL The endpoint URL where webhook payloads will be sent when triggered.
Webhook Events The list of events that will trigger the webhook to send data to the specified URL.
Integration Boolean flag indicating whether the webhook is for integration purposes (should be false for normal use).
Request Options Additional request options such as batching, SSL certificate validation, proxy settings, and timeout configuration.

Output

JSON

  • webhookId - The unique identifier of the created webhook.
  • webhookName - The name of the created webhook.
  • webhookUrl - The endpoint URL where webhook payloads will be sent.
  • webhookEvents - The list of events that trigger the webhook.
  • integration - Indicates if the webhook is for integration purposes.
  • requestOptions - The request options used when creating the webhook, including batching, SSL, proxy, and timeout settings.

Dependencies

  • An API key credential for Aimfox API authentication

Troubleshooting

  • Ensure the webhook URL is reachable and correctly formatted to avoid connection errors.
  • Verify that the selected webhook events are valid and supported by the Aimfox API.
  • Check API credentials and permissions to ensure the node can create webhooks.
  • If SSL issues occur, consider enabling the 'Ignore SSL Issues' option, but be aware of security risks.
  • Timeout errors may occur if the server is slow to respond; adjust the timeout setting accordingly.

Discussion