DAdagucloud
notifications

Send a test DAG notification

Changed on

Sends a test notification to one target or every enabled target for a DAG. Developer, manager, or admin only.

post/dags/{fileName}/notifications/test

Request

  • Base URL
    http://localhost/api/v1
  • Auth
    • HTTP bearer
    • or HTTP basic
    • or none

Path parameters

fileNamestring regex required

Name of the DAG file

the name of the DAG file

Query parameters

remoteNodestring

name of the remote node

Request body

targetIdstring

Optional DAG-local target ID, subscription ID, or channel ID. When omitted, every enabled target and subscription is tested.

eventType'dag.run.waiting' | 'dag.run.succeeded' | 'dag.run.partially_succeeded' | 'dag.run.failed' | 'dag.run.aborted' | 'dag.run.rejected'

DAG run event that can trigger server-side notifications. Rules configured for dag.run.succeeded also match dag.run.partially_succeeded; rules configured only for dag.run.partially_succeeded do not match clean successes.

Response

Test notification delivery attempted

Changes

  • v1a1d783b35e5cRevision changes
    • warning

      added the new command enum value to the // response property for the response status

  • v18110676aca90Revision changes
    • warning

      added the new teams enum value to the // response property for the response status