Skip to main content

Setting Up Notifications

Creating a channel​

  1. Open your project settings and select Notifications.
  2. Click Add Channel.
  3. Give the channel a name.
  4. Pick a destination. The list is searchable and has two groups:
    • Built-in: Reply to sender answers in the thread of the upload mail; Forward to email sends to addresses you enter on the channel. Both are ready to use, nothing to set up.
    • Team connectors: HTTP, FTP, SFTP and email connectors managed in your team's Integration settings.
  5. Fill in the destination-specific field when it appears:
    • HTTP: the endpoint URL that receives the payload.
    • FTP / SFTP: the remote folder the payload file is written to.
    • Reply to sender: optional additional recipients that get a copy of every reply.
    • Forward to email: the recipients, at least one.
    • Email connector: optional override recipients. Leave empty to use the connector's own addresses.
  6. Tick the events you want to receive. See Selecting events.
  7. Optionally add a transformer to reshape the payload.
  8. Click Create channel.

Selecting events​

Each event is a switch with a short description of when it fires.

  • Upload updates lists the upload events. Switch on the ones this channel should receive.
  • Task updates lists every active step in your pipeline. Open a step to switch on the task events for that step. The badge next to a closed step shows how many of its events are on. A step without any event switched on sends nothing.

All events are always listed, even when a feature behind one of them is turned off in the project. An event for a disabled feature simply never fires, so you can prepare a channel before enabling filtering or duplicate detection.

Transforming the payload​

By default a channel sends the JSON payload described in Notification Payloads. A transformer lets you turn that payload into the format your system expects: a different JSON shape, XML, CSV, plain text or HTML. The editor shows the payload fields and previews the result as you type.

Email channels​

  • Email channels send a formatted message per event, not the raw payload. The report and discard messages include the reviewer's message and ticked issues.
  • Reply to sender only sends for uploads that arrived by email. Uploads created through the app or the API produce no reply; add a Forward to email channel for those.
  • Recipients entered on a channel belong to that channel. Switching the channel between the built-in destinations and an email connector keeps them.
  • An email connector's whitelist patterns also apply to recipients entered on the channel.

Testing a channel​

  1. Create a test upload in the project.
  2. Trigger the event you subscribed to, for example by reviewing or discarding a task.
  3. Check that your system received the notification, or open the connector's Deliveries page in the team's Integration settings to see what was sent and whether it was accepted.

Managing channels​

On the Notifications page each channel shows what it sends and where. From there you can:

  • Edit the name, connector, events and transformer.
  • Pause a channel with the toggle. A paused channel keeps its settings but sends nothing.
  • Delete a channel from the Danger zone at the bottom of its page.

Next: Notification Events →