Documentation
Documentation
    • English (United States)
Webhook URL
Close API Documentation
Webhook URL

The webhook URL represents a single URL to which an event is delivered to.

A webhook URL can change over time. This is why we use a dedicated entity to represent the URL. In the webhook listener we reference this entity. This allows the change of the URL for all listener at the same time.

States
  • Create
    The create state indicates that the Webhook URL is in creation.
  • Active
    The active state indicates that the Webhook URL is active and may be used.
  • Inactive
    The inactive state indicates that the Webhook URL is inactive and may not be used.
  • Deleting
    The deleting state indicates that the Webhook URL is in the process to be deleted.
  • Deleted
    The deleted state marks the entity for purging from the database.
Properties
  • Application Managed
    Whether the webhook URL is managed by the application, and therefore cannot be changed via the user interface.
  • ID
    A unique identifier for the object.
  • Linked Space ID
    The ID of the space this object belongs to.
  • Name
    The name used to identify the webhook URL.
  • Planned Purge Date
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • State
    The object's current state.
  • Url
    The actual URL where notifications about entity changes are sent to.
  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.