​
About webhooks

As an alternative to polling the Sieve API for a job to complete, webhooks allow Sieve to notify your API when results are ready. This eliminates unnecessary polling requests, and can get results back faster. In addition, webhooks can be triggered by the Sieve website, which can enable complex workflows with an accessible interface.

Webhooks in Sieve are delivered as POST requests. They are retried up to ten times using exponential backoff until a 200 status code is received.

​
Event types

The following is a full list of all webhook event types. Click the events to see the exact response payload.

EventDescription
job.startOccurs when a job starts.
job.completeOccurs when a job completes, errors, or is cancelled.
job.complete.no_outputOccurs when a job completes, errors, or is cancelled — excludes the output payload from the response.
job.new_outputOccurs when a job produces a new output.

​
Using webhooks via the HTTP API

The website webhook.site provides a great way to test webhooks. Copy the unique URL presented to you on the website.

Submit a new job by sending a POST request to the /v2/push endpoint:

  curl 'https://mango.sievedata.com/v2/push' \
  -H 'X-API-Key: <your api key>' \
  -H 'Content-Type: application/json' \
  -X POST \
  --data-raw '{
    "function": "sieve/dubbing",
    "inputs": {
        "file": {
          "url": "https://storage.googleapis.com/sieve-public-data/assets/dub.m4a"
      }
     },
    "webhooks": [{
            "type": "<event type>",
            "url": "<your webhook url>"
        }]
  }'

Once the job completes, you’ll receive a notification on webhook.site with the output of the job.

If a list of webhooks is specified via the REST API or Python client, this will override any webhooks set on the UI.