Incoming Webhook

An incoming webhook is a SuperAnnotate server endpoint designed to receive requests from external services. Its purpose is to notify the SuperAnnotate instance whenever a significant event occurs on your server. Rather than regularly polling your server for updates, setting up webhooks enables the SuperAnnotate application to receive updates automatically.

Configuration

In the pipeline editor's right panel, you'll find the following configurations for the Incoming Webhook event:

• URL: This URL serves as the endpoint for sending a JSON payload with relevant data. Each card has a unique URL.
• API Key: This key verifies your identity and establishes a secure connection with the server. Include the API Key header assigned to your account or application in your HTTP request for authentication.

API Key header

API-key: <your_api_key>

Replace <your_api_key> with the API key provided on the platform.

🚧

Limitations and restrictions

• HTTP Method: SuperAnnotate accepts incoming webhook events only through the HTTP POST method.
• Payload Format: Webhook payloads must be in JSON format.
• Payload size threshold: The payload size threshold is set to 128 KB.
• Authentication: All incoming webhooks require API Key authentication for enhanced security. Refer to the configuration guide here.
• Action Types: SuperAnnotate may only support connection to Webhook send and Custom actions.

Custom action input JSON

When the Custom Action is triggered by the Incoming Webhook event, the Input JSON will be structured as shown below. For detailed descriptions of each key, please refer to the key dictionary.

{
    "uuid": 2783511,
    "event": "item u",
    "pipeline_id": 0,
    "trigger_result_id": 3456
}

The content of the Context object varies depending on the specific requirements of your application.

Send Webhook Request

When the Send webhook action is triggered by the Incoming Webhook event, the Request JSON will be structured as shown below. For detailed descriptions of each key, please refer to the key dictionary.

{
    "Accept": "application/json;charset=UTF-8",
    "X-Event": "Incoming Webhook",
    "X-Delivery": "1781581",
    "Content-Type": "application/json",
    "X-Authorization-Content-SHA256": "<autogenerated_key>"
}

The Payload sent in the HTTP POST request includes JSON-formatted data, the content of which varies depending on the specific requirements of your application.