search
Go to Valohai AppBook a Demo

Notification Payload Formats

hashtag
Dataset events

{
    project=<project-id>,
    type="dataset_version_created",
    title="Dataset version created: <new-version-name>",
    body="New dataset version <new-version-name> was created",
    data={
        "dataset": {
            "name": <dataset-name>,
            "id": <dataset-id>,
            "tags": [<dataset-tags>],
        },
        "version": {
            "id": <new-version-id>,
            "name": <new-version-name>,
            "uri": "dataset://<dataset-name>/<new-version-name>",
            "created_by": <username>,
            "tags": [<version-tags>],
        },
    },
}

hashtag
Datum Alias events

hashtag
Model events

Variations based on the notification type:

  • Model version created

  • Model version status change

  • Model latest approved version change

  • Model version tags change

  • Model tags change

hashtag
Execution events

💡Timestamps will be in the next format: 2025-12-16T15:36:52.445564+00:00

❗Dots (.) in the field names, under the data object, have to be escaped using \ when used as a lookup path in the notification trigger payload. For instance, if you want to run a trigger only when the step name of the completed execution is "training," the lookup path would be data.valohai\.execution-step.

Variations based on the notification type:

  • Execution is created

  • Execution completes

  • Execution is stopped

  • Execution fails

  • Watchdog detects a failed execution

💡<installation-address> in case you are using private/self-hosted installation, will be the address/domain name of your installation.

Otherwise, it will be app.valohai.com

If the original execution that caused this trigger to run was part of a Pipeline, the following fields will also be included in the data object:

If the original execution that caused this trigger to run was part of a Task, the following fields will also be included in the data object:

If the original execution that caused this trigger to run was also created/started by a trigger, the following fields will also be included in the data object:

hashtag
Pipeline events

❗ Dots (.) in the field names, under the data object, have to be escaped using \ when used as a lookup path in the notification trigger payload. For instance, if you want to run a trigger only when the title of the completed pipeline contains "training" in it, the lookup path would be data.valohai\.pipeline-title.

Variations based on the notification type:

  • Pipeline completes

  • Pipeline errors

  • Pipeline node approval required

💡For the notification type of Pipeline node approval required, next fields will not be included under the data object:

  • valohai.pipeline-n_complete_nodes

  • valohai.pipeline-n_error_nodes

  • valohai.pipeline-n_total_nodes

  • Pipeline stops

hashtag
Task events

💡Tasks allow you to run multiple pipelines in parallel as well (not only executions), based on the variation of one of the pipeline parameters.

❗ Dots (.) in the field names, under the data object, have to be escaped using \ when used as a lookup path in the notification trigger payload.

Variations based on the notification type:

  • Task completes

  • Task fails

  • Task stops

hashtag
Deployment events

  • Deployment finishes

    • HTML-BODY format

❗ Dots (.) in the field names, under the data object, have to be escaped using \ when used as a lookup path in the notification trigger payload.

hashtag
Resource Utilization events

💡 Rely on the content of the body field for the correct (under)utilization values and the reason why this event is triggered, rather than on the type field.

hashtag
User related events

  • Mentioned in a comment

PreviousNotification TriggersNextDataset Version Trigger

Last updated

Was this helpful?