Documentation
Documentation
Webhook Identity
Close API Documentation
Webhook Identity

The webhook identity represents a set of keys that will be used to sign the webhook messages.

States
  • Create
    The create state indicates that the Webhook Identity is in creation.
  • Active
    The active state indicates that the Webhook Identity is active and may be used.
  • Inactive
    The inactive state indicates that the Webhook Identity is inactive and may not be used.
  • Deleting
    The deleting state indicates that the Webhook Identity 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 identity name is used internally to identify the webhook identity 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
  • Version
    The version number indicates the version of the entity. The version is incremented whenever the entity is changed.