webhooks

Get the webhook's public URL

Changed on

Returns the webhook's public URL through Dagu Cloud, the state of the relay connection that holds it, and its latest deliveries. Developer, manager, or admin only.

get/dags/{fileName}/webhook/public

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

Response

The public URL and its deliveries

urlstring

The public URL; absent until Dagu Cloud has given this server its address

state'active' | 'connecting' | 'overLimit' | 'error' required

Whether Dagu Cloud holds the public URL: active once it does, connecting before then, overLimit when the plan allows fewer public URLs than exist and this one is left out, and error when the server cannot connect.

errorstring

Why the server cannot connect

maxHooksinteger

The most public URLs the plan allows, once known

Changes