React Native SDK: API reference

DobroDeskSdkConfig

Required

Framework configuration supplies app identity and account scope and obtains a fresh short-lived authorization token from the host credential provider. Token and result shapes follow the displayed platform signature.

{ apiOrigin: string; integrationId: string; accountScope: string; locale?: SdkLocale; turnstileToken?: string; pollIntervalMs?: number; fetchImpl?: typeof fetch; credentialProvider: () => Promise<{ authorizationToken: string }>; hostActions?: HostActionHandlers; context?: JsonObject }

Errors

• invalid-config

DobroDeskReactNativeClient

Creates the client and validates the integration configuration.

new DobroDeskReactNativeClient(nativeModule, config: DobroDeskSdkConfig)

createDobroDeskReactNativeClient

Creates the client and validates the integration configuration.

createDobroDeskReactNativeClient(config: DobroDeskSdkConfig): DobroDeskReactNativeClient

startSession

Starts one conversation with an idempotent initial message.

startSession(message: string, options?: Omit<SessionStartInput, 'message'>): Promise<Object>

Errors

• network
• field-invalid
• idempotency-conflict
• outbox-corrupt

resumeSession

Restores account-scoped state or resumes a server session when one exists.

resumeSession(): Promise<Object | null>

Errors

• network
• session-expired
• outbox-corrupt

refresh

Loads the current conversation snapshot.

refresh(): Promise<Object>

Errors

• network
• session-expired
• message-rejected

waitForAssistant

Polls with bounded timing until assistant work completes or the wait expires.

waitForAssistant(options?: Omit<WaitForAssistantOptions, 'pollIntervalMs'>): Promise<Object>

Errors

• realtime-unavailable
• network
• session-expired

sendMessage

Sends a message and returns its accepted, queued or review status.

sendMessage(text: string, idempotencyKey?: string): Promise<Object>

Errors

• network
• idempotency-conflict
• conversation-stale
• rate-limited
• message-rejected

flushOutbox

Replays pending mutations with the original body and idempotency key.

flushOutbox(): Promise<ReadonlyArray<Object>>

Errors

• network
• outbox-corrupt
• session-expired

resetSession

Clears the account-scoped session, snapshot and pending mutations.

resetSession(): Promise<void>

Errors

• request-in-progress
• outbox-corrupt

setAuthorizationToken

Supplies the latest short-lived token to a native bridge.

setAuthorizationToken(token: string): Promise<void>

logout

Ends the active customer session and disposes optional capability state.

logout(): Promise<void>

Errors

• outbox-corrupt

presentWidget

Presents the native widget using the shared widget experience.

presentWidget(options?: NativeWidgetOptions): Promise<void>

Errors

• invalid-config
• request-in-progress
• field-invalid

closeWidget

Closes the current native presentation or releases a mounted host.

closeWidget(): Promise<void>

subscribe

Subscribes to canonical SDK events. Release the listener with the subscription, cancellation callback or stream subscription returned by that platform.

subscribe(listener: (event: SdkEvent) => void): () => void

operations

Exposes typed form, client-tool, attachment and commerce operations over the native engine.

operations: DobroDeskRichOperations

submitForm

Submits bounded values for a server-provided conversation form. The request identifier and values are validated before the signed native request is sent.

operations.submitForm(requestId: string, values: JsonObject): Promise<JsonValue>

Returns

Promise<JsonValue>

Errors

• field-invalid
• network
• http
• session-expired
• message-rejected

requestClientTool

Requests an allowlisted client tool, acknowledges its result or reads its status. Tool payloads are flat, bounded and reject sensitive field names.

operations.requestClientTool(input: ClientToolRequest): Promise<JsonValue>

Returns

Promise<JsonValue>

Errors

• field-invalid
• network
• http
• session-expired
• not_found

completeClientTool

Requests an allowlisted client tool, acknowledges its result or reads its status. Tool payloads are flat, bounded and reject sensitive field names.

operations.completeClientTool(input: ClientToolResult): Promise<JsonValue>

Returns

Promise<JsonValue>

Errors

• field-invalid
• network
• http
• session-expired
• not_found

clientToolStatus

Requests an allowlisted client tool, acknowledges its result or reads its status. Tool payloads are flat, bounded and reject sensitive field names.

operations.clientToolStatus(callId: string): Promise<JsonValue>

Returns

Promise<JsonValue>

Errors

• field-invalid
• network
• http
• session-expired
• not_found

procedureAction

Advances a server-provided procedure action with an idempotency key and the expected workflow revision.

operations.procedureAction(input: ProcedureActionInput): Promise<JsonValue>

Returns

Promise<JsonValue>

Errors

• field-invalid
• network
• http
• session-expired
• message-rejected
• idempotency-conflict

attachmentIntents

Creates upload intents and uploads selected local files under the SDK size, type, URI and policy limits.

operations.attachmentIntents(messageId: string, attachments: readonly AttachmentDescriptor[]): Promise<JsonValue>

Returns

Promise<JsonValue>

Errors

• field-invalid
• network
• http
• session-expired
• attachment_policy_failed
• attachment_rate_limited

uploadAttachment

Creates upload intents and uploads selected local files under the SDK size, type, URI and policy limits.

operations.uploadAttachment(intent: AttachmentUploadIntent, fileUri: string, mimeType: string): Promise<JsonValue>

Returns

Promise<JsonValue>

Errors

• field-invalid
• network
• http
• session-expired
• attachment_policy_failed
• attachment_rate_limited

listOrders

Reads scoped order data and creates, confirms or reads a bounded Shopify order-cancellation proposal.

operations.listOrders(query?: CommerceOrderQuery): Promise<JsonValue>

Returns

Promise<JsonValue>

Errors

• field-invalid
• network
• http
• session-expired
• commerce_identity_required
• commerce_unavailable
• shopify_reconnect_required
• shopify_rate_limited

orderDetail

Reads scoped order data and creates, confirms or reads a bounded Shopify order-cancellation proposal.

operations.orderDetail(orderRef: string): Promise<JsonValue>

Returns

Promise<JsonValue>

Errors

• field-invalid
• network
• http
• session-expired
• commerce_identity_required
• commerce_unavailable
• not_found

createCommerceProposal

Reads scoped order data and creates, confirms or reads a bounded Shopify order-cancellation proposal.

operations.createCommerceProposal(input: CommerceProposalInput, idempotencyKey: string): Promise<JsonValue>

Returns

Promise<JsonValue>

Errors

• field-invalid
• network
• http
• session-expired
• commerce_identity_required
• commerce_unavailable
• shopify_reconnect_required
• shopify_rate_limited
• idempotency-conflict

confirmCommerceProposal

Reads scoped order data and creates, confirms or reads a bounded Shopify order-cancellation proposal.

operations.confirmCommerceProposal(proposalId: string, idempotencyKey: string): Promise<JsonValue>

Returns

Promise<JsonValue>

Errors

• field-invalid
• network
• http
• session-expired
• commerce_identity_required
• commerce_unavailable
• shopify_reconnect_required
• shopify_rate_limited
• not_found
• idempotency-conflict

commerceProposal

Reads scoped order data and creates, confirms or reads a bounded Shopify order-cancellation proposal.

operations.commerceProposal(proposalId: string): Promise<JsonValue>

Returns

Promise<JsonValue>

Errors

• field-invalid
• network
• http
• session-expired
• commerce_identity_required
• commerce_unavailable
• not_found

ClientToolRequest

Requests an allowlisted client tool, acknowledges its result or reads its status. Tool payloads are flat, bounded and reject sensitive field names.

{ toolName: string; basisMessageId: string; input: ClientToolPayload }

ClientToolResult

Requests an allowlisted client tool, acknowledges its result or reads its status. Tool payloads are flat, bounded and reject sensitive field names.

{ callId: string; output: ClientToolPayload }

AttachmentDescriptor

Creates upload intents and uploads selected local files under the SDK size, type, URI and policy limits.

{ clientId: string; fileName: string; mimeType: string; sizeBytes: number; kind: AttachmentKind }

AttachmentUploadIntent

Creates upload intents and uploads selected local files under the SDK size, type, URI and policy limits.

{ clientId: string; attachmentId: string; uploadUrl: string; uploadToken: string; expiresAt: string }

CommerceProposalInput

Reads scoped order data and creates, confirms or reads a bounded Shopify order-cancellation proposal.

{ actionId: "shopify_order_cancel"; selection: { storeReference: string; orderReference: string; lineItems?: { lineItemReference: string; quantity: number }[] } }

DobroDeskLoadingState

The shared loading state is one of idle, starting-session, loading-messages, sending-message, waiting-for-assistant, executing-action, reconnecting or flushing-outbox.

"idle" | "starting-session" | "loading-messages" | "sending-message" | "waiting-for-assistant" | "executing-action" | "reconnecting" | "flushing-outbox"

SdkEvent

Native and wrapper events use the shared loading, session, snapshot, accepted-message, error and session-cleared envelope.

loading(state: DobroDeskLoadingState) | session-cleared | session-started | snapshot | message-accepted | error | host-action-requested | host-action-cancelled

WidgetExperience

The shared appearance-v2 object: colors, typography, layout and shadow within documented bounds.

schemaVersion, locale, appearance, platformOverrides, presentation, reducedMotion, copy

Errors

• field-invalid
• unsupported

DobroDeskWidgetView

Presents the native widget using the shared widget experience.

<DobroDeskWidgetView client={client} options?: NativeWidgetOptions visible?: boolean style?: ViewStyle onError?: (error) => void loadingBuilder?: () => ReactNode errorBuilder?: (error, retry) => ReactNode />

createInlineWidgetOwner

Presents the native widget using the shared widget experience.

createInlineWidgetOwner(): DobroDeskInlineWidgetOwner

prepareInlineWidget

Presents the native widget using the shared widget experience.

prepareInlineWidget(options?: NativeWidgetOptions, owner?: DobroDeskInlineWidgetOwner): Promise<{ config; widget; lease: DobroDeskInlineWidgetLease }>

Errors

• invalid-config
• request-in-progress
• field-invalid

releaseInlineWidget

Closes the current native presentation or releases a mounted host.

releaseInlineWidget(ownerOrLease?: DobroDeskInlineWidgetOwner | DobroDeskInlineWidgetLease): Promise<void>

NativeOperation (wrapper bridge)

Exposes typed form, client-tool, attachment and commerce operations over the native engine.

operation: "complete-host-action" | "request-client-tool" | "complete-client-tool" | "client-tool-status" | "submit-form" | "procedure-action" | "attachment-intents" | "upload-attachment" | "list-orders" | "order-detail" | "create-commerce-proposal" | "confirm-commerce-proposal" | "commerce-proposal"

complete-host-action (local bridge)

Framework wrappers encode host-action completion through a local native presenter bridge. It is not sent as an HTTP operation through the direct native client.

{ operation: "complete-host-action"; requestId: string; actionId: string; result: HostActionResult }

Returns

JsonValue

Errors

• field-invalid
• session-expired
• unsupported

attachVoice

Attaches a separately installed, host-owned voice capability.

attachVoice(port: DobroDeskVoicePort): Promise<DobroDeskVoiceFacade>

Errors

• unsupported
• invalid-config

voice

Controls an optional host-installed voice capability: start, stop, mute, barge-in and disposal. The browser widget may render voice UI, but this SDK API controls only a host-provided voice bridge.

voice: DobroDeskVoiceFacade | undefined

createReactNativeVoicePort

Attaches a separately installed, host-owned voice capability.

createReactNativeVoicePort(bridge): DobroDeskVoicePort

voice lifecycle

Controls an optional host-installed voice capability: start, stop, mute, barge-in and disposal. The browser widget may render voice UI, but this SDK API controls only a host-provided voice bridge.

start(): Promise<void>; stop(): Promise<void>; setMuted(muted: boolean): Promise<void>; bargeIn(): Promise<void>; dispose(): Promise<void>

Errors

• invalid-configuration
• permission-denied
• audio-unavailable
• session-expired
• realtime-unavailable
• invalid-response
• protocol-violation
• stale-frame
• queue-overloaded
• cancelled
• unsupported

push module (native only)

Describes the separate opt-in native push artifact and host registration flow. Framework wrappers do not export a JavaScript or Dart push client; use the iOS or Android native module.

No JS/Dart wrapper export; use the iOS DobroDeskPush product or Android com.dobrodesk:dobrodesk-push:<version>.

SdkErrorCode

Handle stable machine-readable codes and keep server diagnostics out of customer UI.

invalid-config | network | http | integration-disabled | integration-paused | origin-not-allowed | turnstile-required | turnstile-failed | request-in-progress | idempotency-conflict | conversation-limit-reached | rate-limited | payload-too-large | field-invalid | conversation-stale | session-expired | realtime-unavailable | message-rejected | outbox-corrupt | unsupported