Developer.TACC.cloud

Developer documentation for Agave, Abaco, and other TACC APIs

URL Macros

In the context of Agave, a webhook is a URL to which Agave will send a POST request when that event occurs. A webhook can be any web accessible URL. While you cannot customize the POST content that Agave sends (it is unique to the event), you can take advantage of the many template variables that Agave provides to customize the URL at run time. The following tables show the webhook template variables available for each resource. Use the select box to view the macros for different resources.

Variable Description
UUID The UUID of the app.
EVENT The event which occurred
APP_ID The application id (ex. sabermetrics-2.1)

The value of webhook template variables is that they allow you to build custom callbacks using the values of the resource variable at run time. Several commonly used webhooks are shown in the tables above.

Receive a callback when a new user is created that includes the new user’s information

https://example.com/sendWelcome.php?username=${USERNAME}&email=${EMAIL}&firstName=${FIRST_NAME}&lastName=${LAST_NAME}&src=agaveapi.co&nonce=1234567

Receive self-describing job status updates

http://example.com/job/${JOB_ID}?status=${STATUS}&lastUpdated=${LAST_UPDATED}

Get notified on all jobs going into and out of queues

http://example.com/system/${EXECUTION_SYSTEM}/queue/${QUEUE}?action=add
http://example.com/system/${EXECUTION_SYSTEM}/queue/${QUEUE}?action=subtract

Rerun an analysis when a files finishes staging

https://$AGAVE_BASE_URL/jobs/v2/a32487q98wasdfa9-09090b0b-007?action=resubmit

Use plus mailing to route job notifications to different folders

nryan+${EXECUTION_SYSTEM}+${JOB_ID}@gmail.com