webhooks

Configure webhook HMAC

Updates the webhook HMAC auth mode or enforcement mode without rotating the secret. If enforcementMode is omitted, the current enforcement mode is preserved for token_and_hmac, while hmac_only always uses strict. Developer, manager, or admin only.

post/dags/{fileName}/webhook/hmac/configure

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

authMode'token_and_hmac' | 'hmac_only' required
enforcementMode'strict' | 'observe'

How HMAC validation is enforced when HMAC is enabled

Response

Webhook HMAC updated successfully

idstring uuid required

Unique identifier for the webhook

dagNamestring required

Name of the DAG this webhook triggers

tokenPrefixstring required

First 8 characters of the token for identification

enabledboolean required

Whether the webhook is active

authMode'token_only' | 'token_and_hmac' | 'hmac_only' required

Authentication mode for a webhook trigger endpoint

createdAtstring date-time required

When the webhook was created

updatedAtstring date-time required

When the webhook was last modified

createdBystring

User ID who created the webhook

lastUsedAtstring date-time

When the webhook was last triggered

Changes

Changed in 4 of the 70 revisions of this API.165

    • added the required property profileSelection to the response with the 200 status

      response-required-property-added

    • added the new conflict enum value to the code response property for the response status 400

      response-property-enum-value-added

    • added the new conflict enum value to the code response property for the response status 404

      response-property-enum-value-added

    • added the new conflict enum value to the code response property for the response status 501

      response-property-enum-value-added

    • added the new conflict enum value to the code response property for the response status default

      response-property-enum-value-added

    • added the new human_task_resume_failed enum value to the code response property for the response status 400

      response-property-enum-value-added

    • added the new human_task_resume_failed enum value to the code response property for the response status 404

      response-property-enum-value-added

    • added the new human_task_resume_failed enum value to the code response property for the response status 501

      response-property-enum-value-added

    • added the new human_task_resume_failed enum value to the code response property for the response status default

      response-property-enum-value-added

    • added the new payload_too_large enum value to the code response property for the response status 400

      response-property-enum-value-added

    • added the new payload_too_large enum value to the code response property for the response status 404

      response-property-enum-value-added

    • added the new payload_too_large enum value to the code response property for the response status 501

      response-property-enum-value-added

    • added the new payload_too_large enum value to the code response property for the response status default

      response-property-enum-value-added

    • added the new rate_limited enum value to the code response property for the response status 400

      response-property-enum-value-added

    • added the new rate_limited enum value to the code response property for the response status 404

      response-property-enum-value-added

    • added the new rate_limited enum value to the code response property for the response status 501

      response-property-enum-value-added

    • added the new rate_limited enum value to the code response property for the response status default

      response-property-enum-value-added

    • removed the rate_limited enum value from the code response property for the response status 400

      response-property-enum-value-removed

    • removed the rate_limited enum value from the code response property for the response status 404

      response-property-enum-value-removed

    • removed the rate_limited enum value from the code response property for the response status 501

      response-property-enum-value-removed

    • removed the rate_limited enum value from the code response property for the response status default

      response-property-enum-value-removed

    This revision also has 86 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog