Knit UI Component Event Glossary
Here is a list of events that are emitted from knit-auth component
| Event ID | Description | Example Payload [event.detail] |
|---|---|---|
onNewSession | This event is emitted when the Knit UI component loads. You can use it as a hook to call your backend to get the authSessionToken from this API: https://developers.getknit.dev/reference/auth-session-creation-api | |
onFinish | Upon completion of the integration setup flow, an integrationDetails object is emitted through the onFinish event, one can access the integrationDetails using event.detail.integrationDetails | {"integrationDetails":{"integrationId":"integration_id","appId":"hubspot","categoryId":"CRM","originOrgId":"org1","success":true}} |
onDeactivate | Upon deactivation of the integration, an integrationDetails object is emitted through the onDeactivate event, one can access the integrationDetails using event.detail.integrationDetails | {"integrationDetails":{"integrationId":"integration_id","appId":"hubspot","categoryId":"CRM","originOrgId":"org1","isDeactivated":true}} |
onKnitClose | Upon closing of the knit-auth component, onKnitClose event is emitted | {"knitClosed":true} |
Updated about 1 year ago