Authenticate a user in a conversation

Stores customer-specific authentication credentials for use in integrated flows.

• Can be called at any point during a conversation
• Commonly used at the start of a conversation or after mid-conversation authentication
• May trigger additional actions, such as GenerativeAgent API signals to customer webhooks

This API only accepts the customer-specific auth credentials; the customer is responsible for handling the specific authentication mechanism.

Authorizations

asapp-api-id

string

headerrequired

asapp-api-secret

string

headerrequired

Path Parameters

conversationId

string

required

The identifier for a conversation.

Body

application/json

Contains authentication information for a customer in a conversation.

customerExternalId

string

required

The unique identifier for the customer in your external system.

auth

object

required

An authentication payload that could contain different types of credentials, such as a token, used to authenticate an end user. All of the fields are optional, but at least one will be required

Show child attributes

streamId

string

The unique identifier for the connection where responses should be sent.