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
  • Id
    The ID is the primary key of the entity. The ID identifies the entity uniquely.
  • Linked Space ID
    The linked space id holds the ID of the space to which the entity belongs to.
  • Name
    The URL name is used internally to identify the URL in administrative interfaces. For example it is used within search fields and hence it should be distinct and descriptive.
  • Planned Purge Date
    The planned purge date indicates when the entity is permanently removed. When the date is null the entity is not planned to be removed.
  • State
  • Url
    The URL to which the HTTP requests are sent to. An example URL could look like https://www.example.com/some/path?some-query-parameter=value.
  • Version
    The version number indicates the version of the entity. The version is incremented whenever the entity is changed.