Webhooks

Update webhook

Changed on

Update a webhook: change the URL, replace topics, or toggle active state.

Side effects

  • If you set is_active to true, DualEntry also resets the failure and disabled state of the webhook.
put/public/v2/webhooks/{webhook_uuid}/

Request

  • Base URL: https://api.dualentry.com
  • URL: https://api.dualentry.com/public/v2/webhooks/{webhook_uuid}/
  • Auth: none declared

Path parameters

webhook_uuidstring required

Headers

Idempotency-Keystring

Optional. A unique value (a UUID works well) identifying this operation. If the request is repeated with the same key, the original response is replayed instead of the operation running again, so a retry cannot create a duplicate record. Results are replayable for 48 hours. Reusing a key with a different request body returns 422.

Request body

urlstring nullable
topicsstring[] nullable
is_activeboolean nullable

Response

OK

uuidstring required
urlstring required
topicsstring[] required
is_activeboolean required
disabled_atstring nullable
disabled_reasonstring
created_atstring required
last_modified_atstring required

Changes

  • 4b2d6ee0dff6Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 34b7cf5b4b6cRevision changes
    • info

      added the new optional header request parameter Idempotency-Key