Documentation
Documentation
    • English (United States)
Webhook Listener
Close API 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
  • Enable Payload Signature And State
    Whether signature header and 'state' property are enabled in webhook payload.
  • Entity
    The entity that is to be monitored.
  • Entity States
    The entity's target states that are to be monitored.
  • ID
    A unique identifier for the object.
  • Identity
    The identity used to sign messages.
  • Linked Space ID
    The ID of the space this object belongs to.
  • Name
    The name used to identify the webhook listener.
  • Notify Every Change
    Whether every update of the entity or only state changes are to be monitored.
  • 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.

    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 where notifications about entity changes are sent to.
  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.