Skip to content

Latest commit

 

History

History
93 lines (64 loc) · 3.61 KB

webhooks.md

File metadata and controls

93 lines (64 loc) · 3.61 KB
Raw

Singularity Webhooks

Singularity provides webhooks for changes to the three core types of objects in Singularity: requests, deploys, and tasks.

Webhooks are managed via the API and a separate webhook should be added separately in order to receive updates about all three object types.

SNS Topic Updates

By default, Singularity will use it's own internal queue of webhooks backed by zookeeper. If you would like to save load on zookeeper or have more flexibility in the consumption of task/deploy/request updates, you can instead configure Singularity to produce messages to SNS. In the configuration yaml, you can specify:

webhookQueue:
  queueType: SNS
  awsAccessKey: {my key}
  awsSecretKey: {my secret}
  snsTopics:
    TASK: singularity-task-updates
    DEPLOY: singularity-deploy-updates
    REQUEST: singularity-request-updates

This will cause Singularity to create these topics if they do not exist, and publish messages to SNS rather than sending its own webhooks. The content of these messages still follows the same format outlined below.

Adding a Webhook

In order to create a new Webhook, post the json for the SingularityWebhook to the webhook endpoint.

For example, to receive request updates, send the following json: (create a file webhook.json with your own requestb.in for testing!)

{
    "id": "test-webhook",
    "uri": "http://requestb.in/1lw85s51",
    "type": "REQUEST"
}

Then post that to the webhooks endpoint:

curl -i -X POST -H "Content-Type: application/json" [email protected] \
http://singularityhostname/singularity/api/webhooks

This webhook will start to receive events anytime a Request is created, modified, or deleted.

Webhook Types

Request

Request webhooks are sent every time a request is created, deleted, or updated - as well as when its state changes (because it is paused or enters cooldown.)

Request webhooks are in the format of SingularityRequestHistory objects.

Deploy

Deploy webhooks are sent when deploys are started and finished (fail or succeed.)

Deploy webhooks are in the format of SingularityDeployUpdate objects.

Task

Task webhooks are sent when tasks are launched by Singularity, killed with by Singularity users, and on all task updates recieved from Mesos.

Task webhooks are in the format of SingularityTaskWebhook objects.

Webhook placeholders

Singularity supports placeholders in webhook URIs which will be replaced with their respective values before the URI is actually called.

The following URI placeholder values are supported for each kind of webhook:

  • Request:
    • $REQUEST_ID
  • Deploy:
    • $REQUEST_ID
    • $DEPLOY_ID
  • Task
    • $REQUEST_ID
    • $DEPLOY_ID
    • $TASK_ID

You could, for example, send along the relevant Request ID with a Task-level webhook by creating the following webhook URI in Singularity:

https://my-automation-service.net/webhooks/task?requestId=$REQUEST_ID

Webhook notes

  • Webhooks are only considered successful if the response code to the webhook is between 200 and 299 inclusive.
  • Webhooks will be delivered every 10 seconds (checkWebhooksEveryMillis)
  • Webhooks will be deleted if they fail to deliver and there are more than 50 in the queue (maxQueuedUpdatesPerWebhook)
  • Webhooks will be deleted if they fail to deliver after 7 days (deleteUndeliverableWebhooksAfterHours)
  • For debugging purposes, queued webhook updates can be retrieved from the API