Gladly icon

Gladly

Interact with Gladly API

Overview

This node operation updates the status and metadata of a webhook in the "Webhooks" resource. It allows enabling or disabling the webhook's delivery of notifications and setting the timestamp when the webhook was disabled due to reaching a retry limit. This is useful for managing webhook lifecycle states programmatically, such as temporarily pausing notifications or recording when a webhook was automatically disabled after repeated failures.

Practical examples include:

  • Enabling a webhook after maintenance or issue resolution.
  • Disabling a webhook to stop receiving events without deleting it.
  • Recording the exact time a webhook was disabled due to retry limits for audit or troubleshooting purposes.

Properties

Name Meaning
Enabled Whether the webhook is actively delivering notifications. Values: true or false.
Disabled At Due To Retry Limit The timestamp (ISO 8601 string) indicating when the webhook was disabled because it reached the retry limit.

Output

The node outputs JSON data representing the updated webhook object after applying the changes. This typically includes fields reflecting the current enabled state and any metadata such as the disable timestamp. There is no indication that binary data is output by this operation.

Dependencies

  • Requires an API key credential for authenticating with the external service managing webhooks.
  • The base URL for API requests is set to a placeholder (https://petstore3.swagger.io/api/v3) in the bundled code, which should be replaced with the actual Gladly API endpoint.
  • The node uses standard HTTP headers for JSON content negotiation.

Troubleshooting

  • Common issues:

    • Providing an invalid timestamp format for the "Disabled At Due To Retry Limit" property may cause API errors.
    • Attempting to enable or disable a webhook without proper authentication will result in authorization errors.
    • Network connectivity problems can prevent successful updates.
  • Error messages:

    • Unauthorized or forbidden errors indicate missing or incorrect API credentials.
    • Validation errors from the API may occur if required properties are missing or incorrectly formatted.
  • Resolutions:

    • Ensure the API key credential is correctly configured and has sufficient permissions.
    • Validate timestamps conform to ISO 8601 format.
    • Check network connectivity and API endpoint correctness.

Links and References

Discussion