Documentation Integration

The integration allows to connect a specific Workspace to synchronize customer data and events with their service.

  • Create
    The create state indicates that the Integration is in creation.
  • Active
    The active state indicates that the Integration is active and may be used.
  • Inactive
    The inactive state indicates that the Integration is inactive and may not be used.
  • Deleting
    The deleting state indicates that the Integration is in the process to be deleted.
  • Deleted
    The deleted state marks the entity for purging from the database.
  • Enabled Event Types
    The selected event types will be synchronized to

    The event types which are selected to be enabled will be synchronized to Event types which are not selected will be ignored for this integration.

    By using different integrations which points to different Workspaces it is possible to synchronize particular data into different Workspaces. Each Workspace at the side may have different segmentation rules.

  • ID
    A unique identifier for the object.
  • Integration Name
    The integration name is used internally to identify a specific integration. For example the name is used within search fields and hence it should be distinct and descriptive.
  • Linked Space ID
    The ID of the space this object belongs to.
  • 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.
  • Site ID provides a site ID which allows the authentication against their web service.

    The site ID identifies the Workspace at the side. The site ID can be found in Workspace under Integrations > Settings > Access Keys. A example of a site ID can look like 525f762c17196216b8cc.

  • Space Id
  • State
    The object's current state.
  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.