Skip to main content
Loading...

API docs by

automation_run.finished
Webhook

Request

automation_run.finished events occur when an automation run finishes, whether it succeeded or failed. A run that is deleted before it finishes does not send this event. This event is available to organizations with Automations enabled.

Bodyapplication/jsonrequired
typestringrequired

The event type

Value:"automation_run.finished"
timestampstring, (date-time)required

When the webhook event occurred

attemptedAtstring, (date-time)required

When the delivery was attempted

webhookEventIdstringrequired

ID of the associated webhook event

webhookIdstringrequired

ID of the webhook that notified your endpoint

projectIdstringrequired

The ID of the project the automation belongs to

automationRunobjectrequired
POST
automation_run.finished
Payload
{
  "type": "automation_run.finished",
  "timestamp": "2019-08-24T14:15:22Z",
  "attemptedAt": "2019-08-24T14:15:22Z",
  "webhookEventId": "string",
  "webhookId": "string",
  "projectId": "string",
  "automationRun": {
    "id": "string",
    "automationId": "string",
    "status": "succeeded",
    "errorKind": "rejected"
  }
}

Responses

Return a 2XX status to acknowledge the event.