Skip to main content

Interface: AgentCreateInput

Defined in: type/AgentCreateInput.ts:7

Input object for AgentCreateInput

Properties​

active​

active: boolean

Defined in: type/AgentCreateInput.ts:25

Whether the agent should be active upon creation.

buttonLabels?​

optional buttonLabels?: LocalizedStringInput[]

Defined in: type/AgentCreateInput.ts:23

Localized button labels for the agent.

Validation: Array must not be empty, must contain unique language entries.

descriptions?​

optional descriptions?: LocalizedStringInput[]

Defined in: type/AgentCreateInput.ts:15

Localized descriptions for the agent.

Validation: Array must not be empty, must contain unique language entries.

interactionMode​

interactionMode: AgentInteractionMode

Defined in: type/AgentCreateInput.ts:33

Interaction mode defining the conversational pattern.

names​

names: LocalizedStringInput[]

Defined in: type/AgentCreateInput.ts:11

Localized display names for the agent.

Validation: Array must not be empty, must contain unique language entries.

trigger​

trigger: AgentTrigger

Defined in: type/AgentCreateInput.ts:31

Trigger mechanism that activates the agent interaction.

types​

types: string[]

Defined in: type/AgentCreateInput.ts:29

Classification types for the agent.

Validation: Must be in SCREAMING_SNAKE_CASE format (e.g., ORDER_SUPPORT, PRODUCT_INFO).

webhookBasicAuthPassword?​

optional webhookBasicAuthPassword?: string

Defined in: type/AgentCreateInput.ts:59

Password for HTTP Basic Authentication.

Used together with basicAuthUsername to provide authentication credentials for webhook requests. Both username and password must be provided or both omitted.

webhookBasicAuthUsername?​

optional webhookBasicAuthUsername?: string

Defined in: type/AgentCreateInput.ts:55

Username for HTTP Basic Authentication.

Used together with basicAuthPassword to provide authentication credentials for webhook requests. Both username and password must be provided or both omitted.

webhookSignatureSalt?​

optional webhookSignatureSalt?: string

Defined in: type/AgentCreateInput.ts:51

The salt used to generate HMAC-SHA256 signature for webhook authentication.

When configured, the webhook will include an 'X-Propeller-Signature' header with format 'sha256=<hex_signature>'.

To verify the signature:

  1. JSON stringify the payload
  2. Generate HMAC-SHA256 using this salt and the stringified payload
  3. Compare with the received signature using crypto.timingSafeEqual() to prevent timing attacks

Example (Node.js): const expectedSig = crypto.createHmac('sha256', salt).update(JSON.stringify(payload), 'utf8').digest('hex'); const receivedSig = signature.replace('sha256=', ''); return crypto.timingSafeEqual(Buffer.from(expectedSig, 'hex'), Buffer.from(receivedSig, 'hex'));

webhookTimeoutMs​

webhookTimeoutMs: number

Defined in: type/AgentCreateInput.ts:37

Timeout in milliseconds for webhook requests.

webhookUrl​

webhookUrl: string

Defined in: type/AgentCreateInput.ts:35

URL of the external webhook that processes agent requests. Maximum length of 2048 characters.

welcomeMessages?​

optional welcomeMessages?: LocalizedStringInput[]

Defined in: type/AgentCreateInput.ts:19

Localized welcome messages displayed when the agent is activated.

Validation: Array must not be empty, must contain unique language entries.