> ## Documentation Index
> Fetch the complete documentation index at: https://docs.orbit.devotel.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Dispatch a custom tool call (internal)

> Internal service-to-service endpoint (X-Internal-Token auth) invoked by the agent runtime when the model picks a tenant-owned custom tool. It looks up the tool by name, decrypts its webhook secret server-side, and fans out an HMAC-signed POST to the tool's executor URL (with SSRF re-validation and a per-tool timeout), returning the executor response plus any rotating spoken completion/failure message. Plaintext secrets never leave the API process.



## OpenAPI

````yaml /openapi.yaml post /api/v1/agents/custom-tools/internal/dispatch
openapi: 3.1.0
info:
  title: Devotel CPaaS API
  description: Orbit by Devotel — Communications Platform as a Service API
  version: 1.0.0
  contact:
    name: Devotel
    url: https://devotel.io
    email: support@devotel.io
  license:
    name: Proprietary
servers:
  - url: https://api.orbit.devotel.io
    description: Production
security:
  - Bearer: []
  - ApiKey: []
tags:
  - name: Messages
    description: >-
      Send and manage messages across all channels (SMS, WhatsApp, RCS, Email,
      Viber, etc.)
  - name: Fax
    description: >-
      List and track fax (MMS/T.38) transmissions on Telnyx-backed fax numbers
      (sending flows through the Messaging API)
  - name: Agents
    description: AI agent creation, configuration, and execution
  - name: Voice
    description: Voice calls, IVR, conferencing, and SIP trunking
  - name: OnCall
    description: On-call rotations and escalation policy planning for incident alerting
  - name: Webhooks
    description: Webhook endpoint management and delivery logs
  - name: Numbers
    description: Phone number search, provisioning, and configuration
  - name: Brand Identity
    description: >-
      Unified cross-channel brand trust posture (10DLC, toll-free, WhatsApp,
      RCS, branded calling, number KYC)
  - name: Contacts
    description: Contact management, segmentation, and lifecycle tracking
  - name: Campaigns
    description: Marketing campaign orchestration and analytics
  - name: Flows
    description: Automation flow builder and execution engine
  - name: Templates
    description: Message template management and approval workflows
  - name: Settings
    description: Organization, channel, and user preference settings
  - name: Verify
    description: OTP generation and verification across channels
  - name: Push
    description: Push notification delivery via FCM and APNs
  - name: Integrations
    description: Third-party service connections and OAuth management
  - name: CDP
    description: >-
      Customer Data Platform — activation surface (CRM object sync, streaming
      destinations, ad-audience activation)
  - name: Files
    description: >-
      Server-to-server media upload, listing, retrieval, and deletion
      (signed-URL backed)
  - name: Commerce
    description: >-
      Omnichannel conversational-commerce — persistent cart + checkout state
      machine, channel-agnostic hosted pay-by-link, native WhatsApp checkout,
      and AP2-style agent payment mandates.
  - name: Sync
    description: >-
      Real-time shared-state primitive (Twilio Sync parity) — Documents, Maps,
      Lists, and ephemeral Streams, with change events relayed over the
      /api/v1/ws/sync WebSocket gateway
  - name: Risk
    description: >-
      Unified cross-channel Trust & Fraud risk scoring — fuses SMS-pumping,
      URL-reputation, Verify Fraud Guard, and Voice Biometrics signals into one
      composite verdict queryable before a send or a call.
  - name: Orby
    description: >-
      In-dashboard Orby operator assistant: streamed assistant turns,
      conversation threads, product knowledge-base search, and the tool-action
      approval gate. Available to signed-in operators only (dashboard session
      auth — API-key requests are rejected).
paths:
  /api/v1/agents/custom-tools/internal/dispatch:
    post:
      tags:
        - Agents
      summary: Dispatch a custom tool call (internal)
      description: >-
        Internal service-to-service endpoint (X-Internal-Token auth) invoked by
        the agent runtime when the model picks a tenant-owned custom tool. It
        looks up the tool by name, decrypts its webhook secret server-side, and
        fans out an HMAC-signed POST to the tool's executor URL (with SSRF
        re-validation and a per-tool timeout), returning the executor response
        plus any rotating spoken completion/failure message. Plaintext secrets
        never leave the API process.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - tool_name
                - agent_id
                - agent_run_id
              properties:
                tool_name:
                  type: string
                  description: Slug of the custom tool the model selected.
                args:
                  type: object
                  additionalProperties: true
                  description: >-
                    Arguments the model produced, matching the tool's
                    JSON-Schema.
                agent_id:
                  type: string
                agent_run_id:
                  type: string
                conversation_id:
                  type: string
            example:
              tool_name: lookup_order_status
              args:
                order_id: SO-10432
              agent_id: agt_support_02
              agent_run_id: run_7f21aa
              conversation_id: conv_5521
      responses:
        '200':
          description: The executor response, including timing and any spoken message.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      ok:
                        type: boolean
                      status:
                        type: integer
                        description: >-
                          HTTP status the executor returned (0 when the call
                          never completed).
                      duration_ms:
                        type: integer
                      response_body:
                        description: >-
                          Parsed executor response body (object, string, or
                          null).
                      error:
                        type: string
                        nullable: true
                      spoken_message:
                        type: string
                        nullable: true
                      spoken_start_message:
                        type: string
                        nullable: true
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
        '404':
          description: No custom tool with that name exists for the tenant.
        '409':
          description: The custom tool exists but is disabled.
components:
  schemas:
    ResponseMeta:
      type: object
      required:
        - request_id
        - timestamp
      additionalProperties: false
      properties:
        request_id:
          type: string
          description: Unique request identifier (also returned as X-Request-Id header)
        timestamp:
          type: string
          format: date-time
        docs_url:
          type: string
          format: uri
          nullable: true
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Dashboard JWT token from Clerk
    ApiKey:
      type: apiKey
      name: X-API-Key
      in: header
      description: Server-to-server API key (dv_live_sk_*)

````