Webhooks
Webhooks
Webhooks for LiveTiles Intranet Workspaces can be used by third-party developers who want to hook into the workspace lifecycle at certain events.
Registering a Webhook
Webhooks can be registered on the configuration of a workspace type: Webhooks config reference.
Webhook Events
If a webhook is registered on a workspace type, the Workspaces backend will call the configured URL at certain events.
Event | Description |
---|---|
BeforeCreate | Called before a workspace will be created. Requires the registered webhook endpoint to answer with a valid BeforeWebHookResponse. |
AfterCreate | Called after a workspace has been created. The registered webhook endpoint may answer with a valid AfterWebHookResponse. |
BeforeUpdate | Called before a workspace will be updated. Requires the registered webhook endpoint to answer with a valid BeforeWebHookResponse. |
AfterUpdate | Called after a workspace has been updated. The registered webhook endpoint may answer with a valid AfterWebHookResponse. |
BeforeDelete | Called before a workspace will be deleted. Requires the registered webhook endpoint to answer with a valid BeforeWebHookResponse. |
AfterDelete | Called after a workspace has been deleted. The registered webhook endpoint may answer with a valid AfterWebHookResponse. |
Webhook Payload
The payload will specify the
- The event type
- The absolute URL of the site collection
- Whether the current site collection should be used for the workspace being created
- The LCID the user is using
- The workspace type configuration
- Information regarding the current user
- The values from the workspace fields by key
- The values of fields that have changed