---
title: "Workflow run errored"
method: POST
path: "workflowRunEvents_webhook-workflow-run-errored"
---

# Workflow run errored

`POST workflowRunEvents_webhook-workflow-run-errored` (webhook)

Webhook for the `workflow-run.errored` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).

## Headers

- `Persona-Signature` string
- `Persona-Webhook-Attempts-Made` integer
- `Persona-Webhook-Attempts-Left` integer
- `Persona-Webhook-First-Attempted-At` integer

## Payload

- object
  - `data` WebhooksWebhookWorkflowRunErroredPayloadContentApplicationJsonSchemaData
    - `type` 'event'
    - `id` string: Unique identifier for this Event. Starts with `evt_`.
    - `attributes` WebhooksWebhookWorkflowRunErroredPayloadContentApplicationJsonSchemaDataAttributes
      - `created-at` string, date-time: Datetime when the event was created.
      - `name` 'workflow-run.errored'
      - `payload` WebhooksWebhookWorkflowRunErroredPayloadContentApplicationJsonSchemaDataAttributesPayload
        - `data` WorkflowRun: A Workflow Run object
          - `id` string
          - `attributes` InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunAttributes
            - `completed-at` string, date-time, nullable
            - `created-at` string, date-time
            - `status` string
          - `relationships` InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationships
            - `creator` InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationshipsCreator
              - …
            - `workflow` InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationshipsWorkflow
              - …
            - `workflow-version` InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationshipsWorkflowVersion
              - …
          - `meta` InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunMeta
            - `processing-time-seconds` number, double, nullable
        - `included` WorkflowRunIncludedObjectsItems[]
          - union
            - object: A Workflow object
              - …
            - object: A Workflow Version object
              - …
            - object: An Event object
              - …
            - object: A User object
              - …
            - object: A Scheduled Run object
              - …
      - `context` WebhooksWebhookWorkflowRunErroredPayloadContentApplicationJsonSchemaDataAttributesContext: Additional context for the event. Describes the step that caused the workflow run to error and why. Being rolled out gradually: until it is enabled for your organization, this is `{}`.
        - `errored-step` WebhooksWebhookWorkflowRunErroredPayloadContentApplicationJsonSchemaDataAttributesContextErroredStep: The step that errored. `null` when the run failed as a whole rather than at a step (for example, it expired), or when the run errored before this property existed.
          - `name` string, nullable: Display name of the step in the workflow.
          - `key` string, nullable: Identifier of the step in the workflow version's configuration.
          - `type` string, nullable: Kind of step, for example `action`, `conditional`, `parallel`, `loop`, `module` or `wait`.
          - `action-key` string, nullable: The action the step runs. `null` unless `type` is `action`.
        - `error` WebhooksWebhookWorkflowRunErroredPayloadContentApplicationJsonSchemaDataAttributesContextError: Why the run errored. `null` when the run errored before this property existed.
          - `type` string, nullable: Category of the error, for example `missing-input-error`, `invalid-input-error`, `configuration-error`, `resource-error` or `unknown-error`. `run-failure` when the run failed as a whole rather than at a step.
          - `message` string, nullable: Human-readable description of the error. Only shown for configuration and input errors; every other type reads "An error occurred while executing this step".

## Acknowledgement `200`

Webhook received successfully

---

[API](https://skmtc.dev/withpersona/apis/withpersona-7.md) - [All operations](https://skmtc.dev/withpersona/apis/withpersona-7/llms.txt) - [OpenAPI document](https://skmtc.dev/withpersona/apis/withpersona-7/revisions/904c4b28844f?raw)