LogoLogo
  • GETTING STARTED
    • Welcome to the NLX platform
    • How NLX works
    • Guides
      • Analytics dashboard
      • Chat
      • Generative Journey (Slots)
      • Model Context Protocol
      • Voice
      • Voice+
      • Touchpoint components
        • Carousel modality
        • Video modality
    • Terms & concepts
    • Generative AI
    • Developer
  • Build
    • Workspace setup
    • Flows
      • Intro to flows & variables
      • The Canvas
      • Flow settings
      • Nodes
      • Flow appearance
    • Resources
      • Actions
        • Implementation
        • Request model
      • Analytics tags
      • Context variables
      • Data requests
        • Implementation
        • Response model
        • Request model
      • Knowledge bases
        • Ingest content
        • Add metadata (beta)
        • Apply KB
      • Lifecycle hooks
        • Implementation
      • Modalities
      • Secrets
      • Slots (custom)
        • Adding values
        • Translating slots
      • Voice+ scripts
        • Add + download script
        • Deploy script + install SDK
        • Create Voice+ flow
    • Integrations
      • Channels
        • Alexa
        • Amazon Chime SDK
        • Amazon Connect
        • AWS End User Messaging SMS
        • AWS End User Messaging Social
        • Bandwidth
        • Genesys
        • Twilio
        • Zendesk Sunshine
      • LLM services
        • Amazon Bedrock
        • Anthropic
        • Azure OpenAI
        • Cerebras
        • Cohere
        • Google Vertex AI
        • Groq
        • NVIDIA
        • OpenAI
        • xAI
      • NLP
        • Amazon Lex
        • Google Dialogflow
        • Google Dialogflow CX
        • Custom NLP
    • Translations
  • Test & Deploy
    • Applications
      • Attach flows
      • Assign default behavior
      • Add channels
        • API
          • REST API
        • Alexa
        • Amazon Chime SDK
        • Amazon Connect
        • AWS End User Messaging SMS
        • AWS End User Messaging Social
        • Genesys
        • Genesys SMS
        • Messenger
        • Microsoft Teams
        • Slack
        • SMS via Bandwidth
        • Twilio SMS
        • Twilio Voice
        • WhatsApp via Twilio
        • Zendesk Sunshine
      • Deploy
      • Optional: Set lifecycle
      • Optional: Set languages
    • Test
      • Test a conversation
      • Automated tests
      • Test an external integration
  • Analyze
    • Conversations
    • Analytics
      • Creating dashboards
      • Formulas & multi-metrics
      • Canvas analytics
    • Training
  • Workspace Settings
    • Escalation channels
    • Resource tags
    • Audit
  • Admin
    • Access control
      • Roles & permissions
    • Notifications
    • FAQ
    • Contact support
Powered by GitBook
On this page
  • What's a Lifecycle hook?
  • Requirements
  • Lifecycle hooks features
  • Lifecycle hook settings
  1. Build
  2. Resources

Lifecycle hooks

Trigger general actions at the start, end, or escalation point of your NLX conversations

Last updated 26 days ago

This feature is currently available to enterprise tiers only.

What's a Lifecycle hook?

Lifecycle hooks allow you to send or receive data or trigger an event at particular stages (lifecycles) in a conversation session. They are also useful in receiving data from another system and setting at 'start' of a session.

  • Lifecycle hooks are only executed during specific points in a conversation: at the start of a conversation, at an escalation point within the conversation, at the end of a conversation, or to stream state modifications made to . Data requests and , on the other hand, allow you to be granular about when and where to trigger the operation within a flow

  • Lifecycles are attached to an application rather than referenced in a flow, which is why you don't encounter them when building flows in

To access, click Resources in your workspace menu and choose Lifecycle hooks:

Need more context? See


Requirements

A Lifecycle hook must always employ the following to function:


Lifecycle hooks features


Lifecycle hook settings

A Lifecycle hook's Settings tab provides a few options:

  • Description: Enter or modify an explanation of the resource for better filing and organization in the workspace

Tags: Add or remove for better filing and organization in the workspace

To delete a Lifecycle hook, select the Delete option under Danger zone. If the Lifecycle hook is assigned with an application(s), remove the , and create a to experience the change.

Implementation
Resource tags
lifecycle hook
new application build/re-deploy
Context variables
lifecycle
Data requests
Actions
the Canvas
Application lifecycle
Lifecycle tab