<< Click to Display Table of Contents >> Navigation:  »No topics above this level« Webhooks

 

If you would like to receive notifications for your optimization calls, you should use webhooks. Learn more about webhooks here.

 

A webhook is an HTTP callback that is triggered based on an event (optimization begins, progresses, completes). If you set up a webhook, the service will perform a callback to a designated URL on your domain via HTTP POST request(s).

 

opt/v1/async (see Optimizing) supports two webhooks:

 

POST Progress

 

 ?progress=webhookURL 

 

If specified, the service will call this URL once per second to update the endpoint with current optimization progress for the just-submitted job. The update is provided via a simple POST method to the specified URL.

 

POST Results

 

 ?results=webhookURL 

 

Upon completion, the service will POST the optimization results back to the specified URL. This can happen exactly one time per job, and the results are disposed once sent back.