Create automation

With Automations, you can configure each interaction between your ML infrastructure and the annotation process at SuperAnnotate. This will help you to bind continuous improvement of your models with the generation of ground truth data at SuperAnnotate.

An HTTP POST request will be sent to the selected action when one of these events is triggered.

Create automation

Step 1: Event

In this step, you need to set up the event. An event is an activity within SuperAnnotate, like updating an item's status.

1962
  1. Type an automation name.

  2. Select an event or activity. An event is an activity within SuperAnnotate, like updating an item’s status. Please check this page to see the full list of events and learn more about them.

  3. Choose where you want to set up the automation. You can set up the automation at a team level or limit its scope to a list of specific projects or folders.

The automation is applied at a team level by default. To limit the automation's scope, select Specific projects and choose projects and/or folders from the drop-down list.

  1. Click Next.
493

Step 2: Action

There are currently two types of actions: webhooks and emails.

785

Webhook

This action allows you to set up integrations that subscribe to certain events.
When one of these events is triggered, we'll send an HTTP POST payload to the configured webhook URL.

  1. Choose Send Webhook from the drop-down list.
  2. Enter a request URL. This is the URL of the server that will receive the POST requests from the subscribed event.
  3. Enter the secret HMAC key (not mandatory). The secret key is random string that secures your messages with HMAC. Learn more about HMAC.
  4. Click Next.

📘

About the secret

Setting up a secret allows you to validate that POST requests sent to the Request URL are from SuperAnnotate. This is an optional step that provides additional security to your webhook.

When you set up a secret, SuperAnnotate uses HMAC to compute its hash signature. This hash signature is included within the header of each request as X-Authorization-Content-Sha256, which can be used on the server side to validate whether the request came from SuperAnnotate or not.

Send Email

This action allows you to send email notifications whenever a certain event is triggered. The automatically generated email contains identifiers for the team and project where the event was triggered.

  1. Choose Send Email from the drop-down list.
  2. Select one or multiple email address(es) from the drop-down list. These are the email addresses of the verified team members.
  3. Click Next.

Step 3: Summary

  1. Review your setup before submitting it. Note that you can't make changes later.
  2. Click Create.