[FEAT] Add webhook callback after task completion

[Kaiden0001]

Is it possible to implement a feature where, after completion, cancellation, or failure of a DAG, the dag_json is automatically sent to a specified URL, provided when the task is launched?

[ghansham]

You can use the success,failure handlers to do such tasks. But what does than mean sending json to a url?

[Kaiden0001]

I do not want to create separate handlers for each DAG state (success, failure, cancellation).
Ideally, there should be a single mechanism that triggers the webhook regardless of the task status.

The system should use the provided webhook field to send the DAG results after the task finishes, without needing separate handlers for success, failure, or cancellation.

curl -X POST http://localhost:8080/api/v2/dags/my-dag.yaml/start \
  -H "Content-Type: application/json" \
  -d '{
    "params": "{\"env\": \"production\"}",
    "dagRunId": "custom-run-id",
    "dagName": "adhoc-my-dag",
    "webhook": {
      "url": "https://example.com/webhook",
      "method": "POST",
      "headers": {
        "Authorization": "Bearer your_token",
        "X-Custom-Header": "value"
      }
    }
  }'

Below is an example of the JSON payload that should be sent:

[yottahmd]

@Kaiden0001 Thanks for the suggestion! You can currently define an onExit eventHandler in the base DAG to send a request. Would that work for your case? I'm also thinking to have general webhook functionality implemented some way. For more context, would you mind sharing your specific use case of the webhook?

[Kaiden0001]

I store the task execution logs on my own server. To avoid constantly polling DAGU to check whether the DAG has finished, I would like DAGU to automatically send a request to my server and provide the execution JSON (dag_json) once the DAG completes. This way, I can immediately record the results without extra queries.

[Kaiden0001]

I have a question about using the onExit eventHandler:

• How can I get the execution JSON (dag_run_details) of a DAG run inside onExit?
• Will the JSON contain the final status of the DAG, or will it show running?

[yottahmd]

@Kaiden0001 You can use these variables in the onExit handler, including the finished status of the DAG. https://docs.dagu.cloud/reference/special-environment-variables#reference

However, DAG_RUN_JSON is not available at the moment. Could you tell me the use case for the JSON data?

[ghansham]

You can try accessing this api end point:

/api/v2/dags/$DAG_NAME/dag-runs/latest

It should return the json containing latest dag run details which you can pass on to the curl post request.

You can do that in one shot also: curl -s "https://source.example.com/data" | curl -X POST -H "Content-Type: application/json" --data-binary @- "https://target.example.com/api"

[Kaiden0001]

I need the JSON to store task execution logs on my own server.

My goal is to avoid constantly polling the server for the task I started, and instead wait until it automatically sends the JSON with the data.

Additionally, this JSON should include all the information needed to construct a notification message, so that the DAG status, task results, and launch parameters can be immediately understood.

[ghansham]

See this link for more details:

https://docs.dagu.cloud/reference/api#get-dag-run-history

[ghansham]

If you want to customize you can create a small python/go script that gets this json and extracts required information and create a new json which you can post to your server

[Kaiden0001]

I understand your suggestion. My goal is to minimize manual actions on the server, including the need to create custom scripts.
I would prefer if DAGU could send the execution JSON directly to my server, so no extra processing or scripting is required.

For example, the webhook could be provided at DAG launch like this:

curl -X POST http://localhost:8080/api/v2/dags/my-dag.yaml/start \
  -H "Content-Type: application/json" \
  -d '{
    "params": "{\"env\": \"production\"}",
    "dagRunId": "custom-run-id",
    "dagName": "adhoc-my-dag",
    "webhook": {
      "url": "https://server.com/logs/${dagRunId}", 
      "method": "POST",
      "headers": {
        "Authorization": "Bearer your_token",
        "X-Custom-Header": "value"
      }
    }
  }'

[Kaiden0001]

Should we expect this in the near future?

[Kaiden0001]

Additionally, this feature could be extended in the future —
for example, allowing webhooks not only after DAG completion, but also after a specific stage, or after any task finishes. This would make integrations even more flexible and powerful.

[ghansham]

Very cool idea