Integrating Webhooks

​

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 requests made by polling, 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.

We currently don’t provide a signature to verify sender, but it is a feature we are looking into.

​

Event types

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

​

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>' \
  --data-raw '{
    "function": "sieve/speech_transcriber",
    "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.

​

Using webhooks via the Python client

Webhooks can also be set via the Python client with the webhooks parameter.

f = sieve.function.get("...")
f.run(
    target_audio,
    webhooks=[
        {
            "type": "<event type>",
            "url": "<your webhook url>"
        }
    ]
)

f = sieve.function.get("...")
future = f.push(
    target_audio,
    webhooks=[
        {
            "type": "<event type>",
            "url": "<your webhook url>"
        }
    ]
)
future.result() # Wait for output, you will receive a webhook after this line completes.

The code will run as usual, with the added benefit of a webhook being triggered once the job is complete.

​

Using webhooks via the Sieve dashboard

Webhooks can also be set on a per-function basis via the dashboard. In other words, every time the function is run (from the UI, REST API, or Python client), the webhook will be triggered. Add the webhook on the Settings page once you have a function selected.

Once you submit a run, you should again receive a notification.