Tip: Plug in a valid OAuth access token to make calls to our API from the documentation without leaving your browser.

Webhook notifications

We provide notifications for documents as they go through Shoeboxed processing.
Fill in a desired notification URL for your API client,
and any documents that belong to Shoeboxed users who have granted access to your
application will trigger notifications of its status changes as it moves through
the processing pipeline.

Token is a 50-character random alphanumeric string; Signature is the HMAC
of the token, using SHA-256 as the hash function and your API client secret as
the key, and finally base64-encoded. This serves to verify that the notification
is from Shoeboxed.

An example of computing the signature using the token and client secret using
Python 2.7:

Your application that receives the notification must return a status code in the
200s. If it does not, or if we encounter any other network error, then we will
retry the notification up to 10 times, in increasing intervals. The exact times
at which we will retry the notification are 2^n * 90, where n is the number
of retries between 1 and 10; the resulting number is the number of seconds after
the original notification at which we will attempt to retry.