Skip to main content

Notifications Overview

Notifications tell your systems and your team what happens to uploads and tasks in a project: a file needs review, an upload was processed, a reviewer discarded a task, an export could not be delivered.

How notifications work​

  1. You create one or more channels in the project's Notifications settings. A channel is a connector (HTTP, FTP, SFTP or email) plus a selection of events.
  2. When an event occurs, every active channel that subscribed to it receives a message.
  3. HTTP, FTP and SFTP channels receive the notification payload as JSON, or in whatever shape your transformer produces. Email channels receive a formatted mail.

Two levels of events​

  • Upload events describe the upload as a whole: it needs review, it was processed, it was a duplicate, or all of its files were filtered out.
  • Task events describe one task in one pipeline step: it is in review, completed, failed, filtered, unlocked, discarded, reported, or its export failed. You pick task events per step, so a channel can follow only the steps that matter to it.

See Notification Events for the full list and when each event fires.

Typical uses​

  • Tell an operator when an upload needs manual attention.
  • Start a downstream process when an upload is fully processed.
  • Record discard reasons and reported issues in your own ticketing system.
  • Keep a mailbox informed of filtered or duplicate uploads.

Good to know​

  • Every active channel that subscribes to an event receives it. To avoid duplicate messages, keep the number of channels small.
  • Notifications are sent once per event. If your endpoint rejects a message, it is logged under the connector's deliveries but not retried.
  • A channel without a connector saves its settings but does not send anything.

Next: Setting Up Notifications →