Documentation
Documentation
    • English (United States)
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
    A unique identifier for the object.
  • Linked Space ID
    The ID of the space this object 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 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.
  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.