These components will allow you to effectively build your automations based on various types of events that could take place within the project. You can choose to send a webhook or email as a response to specific events, or use a custom action instead.

To learn more about creating automations, read here.

Events

These are the ‘trigger’ components that your pipeline will look out for. When you choose an event as the trigger, it’ll mean that any time that event takes place in your project, the automation will be activated. If, for instance, you wanted to receive an email update if a particular folder had a status change, you could set up an automation for that.

Below are the available event components that could be used in your pipelines.

External

Incoming webhook

Incoming webhooks are a simple mechanism to integrate external services with the SuperAnnotate platform. When using this component, you'll receive a unique URL to which you can send a JSON payload containing the necessary data.

All incoming webhooks require API Key authentication for enhanced security. To authenticate, include the following header in your HTTP request:

API-key: YOUR_API_KEY

📘

Replace YOUR_API_KEY with the API key provided on the platform.

Scheduler

• Periodic events - This event can be used to schedule a constant trigger with the desired frequency, over a custom period of time.

Project

• Project created
• Project status updated
• Project deleted

Folder

• Folder created
• Folder status updated
• Folder deleted

Export

• Export created
• Export status updated
• Export deleted

Item

• Item created
• Item opened in editor
• Item annotation status updated
• Item approval status updated
• Item annotator assignment updated
• Item QA assignment updated
• Fired in Explore - This event can be used to trigger a pipeline on a number of items directly from Explore. You must provide the event a name when adding it to a pipeline. Then, when selecting one or multiple items in Explore, you can run a pipeline by selecting the event’s name. You can also specify the project scope for this event so that it can only be used in either specific projects, or in all projects of the team.

Actions

Actions are the components you can use to define what takes place after an event has been triggered. You can choose to use the available actions provided, or build your own custom ones from the Actions tab. When an action is carried out, it is logged and can be monitored in your pipeline's history. Learn more.

Below are the available action components that could be used in your pipelines.

Default actions

• Send webhook
• Send email

Custom actions

Here, you’ll see all the custom actions that you’ve created as individual action components that you can use in the canvas. You can edit and add arguments to the event handler function to define how the action handles the event triggers that it’s linked to.

You can link these actions to any secret by using the following code in the action's environment:

import os 

def handler(event, context):
    os.environ["<secret_name>"]