Documentation
Webhook Listener

A webhook can be used to notify another application about events. A webhook listener represents a single listener to such an event.

The notification is carried out by calling the configured webhook URL.

States
  • Create
    The create state indicates that the Webhook Listener is in creation.
  • Active
    The active state indicates that the Webhook Listener is active and may be used.
  • Inactive
    The inactive state indicates that the Webhook Listener is inactive and may not be used.
  • Deleting
    The deleting state indicates that the Webhook Listener is in the process to be deleted.
  • Deleted
    The deleted state marks the entity for purging from the database.
Properties
  • Entity
    The listener listens on state changes of the entity linked with the listener.
  • Entity State
    The target state identifies the state into which entities need to move into to trigger the webhook listener.
  • Id
    The ID is the primary key of the entity. The ID identifies the entity uniquely.
  • Identity
    The identity which will be used to sign messages sent by this listener.
  • Linked Space ID
    The linked space id holds the ID of the space to which the entity belongs to.
  • Name
    The webhook listener name is used internally to identify the webhook listener in administrative interfaces.For example it is used within search fields and hence it should be distinct and descriptive.
  • Notify Every Change
    Defines whether the webhook listener is to be informed about every change made to the entity in contrast to state transitions only.
  • 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

    A webhook listener can have the following states:

    Active

    When the state is set to Active the webhook listener is used.

    Inactive

    When the state is set to Inactive the webhook listener is ignored. However, all the information is not deleted and you can reactivate it at any moment.

    Deleting

    The webhook listener is in the process of deletion. This may take some time until the webhook listener is marked as Deleting before being marked as Deleted.

    Deleted

    The webhook listener is deleted. Since the webhook listener is linked with data which cannot be deleted immediately, we need to keep it until all the data can be removed.

  • Url
    The URL which is invoked by the listener to notify the application about the event.
  • Version
    The version number indicates the version of the entity. The version is incremented whenever the entity is changed.