> ## 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. # Create a custom agent tool > Register a new webhook-backed custom tool for your agents. Supply a lowercase snake_case `name`, a `description` the model reads to decide when to call it, an optional JSON-Schema for the tool's parameters, and the HTTPS `executor_url` Orbit POSTs to when an agent invokes the tool. An optional `executor_secret` is stored encrypted and used to HMAC-sign each dispatch. Names that collide with a built-in tool are rejected, and the executor URL is SSRF-checked at write time. Requires an owner, admin, or developer role. ## OpenAPI ````yaml /openapi.yaml post /api/v1/agents/custom-tools 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: post: tags: - Agents summary: Create a custom agent tool description: >- Register a new webhook-backed custom tool for your agents. Supply a lowercase snake_case `name`, a `description` the model reads to decide when to call it, an optional JSON-Schema for the tool's parameters, and the HTTPS `executor_url` Orbit POSTs to when an agent invokes the tool. An optional `executor_secret` is stored encrypted and used to HMAC-sign each dispatch. Names that collide with a built-in tool are rejected, and the executor URL is SSRF-checked at write time. Requires an owner, admin, or developer role. requestBody: required: true content: application/json: schema: type: object required: - name - description - executor_url properties: name: type: string minLength: 3 maxLength: 64 description: >- Lowercase snake_case identifier the model calls (e.g. lookup_order). description: type: string minLength: 1 maxLength: 1000 description: >- What the tool does — the model reads this to decide when to call it. json_schema: type: object additionalProperties: true description: JSON-Schema for the tool's parameters (max 32KB serialized). executor_url: type: string maxLength: 2000 description: >- HTTPS endpoint Orbit POSTs to when an agent invokes the tool. executor_secret: type: string minLength: 8 maxLength: 512 description: >- Optional secret, stored encrypted, used to HMAC-sign each dispatch. enabled: type: boolean default: true timeout_ms: type: integer minimum: 1000 maximum: 60000 default: 30000 description: Per-call timeout in milliseconds. confirmation: type: string enum: - never - always default: never description: >- Whether the tool call requires operator approval before it runs. example: name: lookup_order description: Look up an order's status and tracking number by order id. json_schema: type: object properties: order_id: type: string required: - order_id executor_url: https://api.example.com/orbit/tools/lookup-order timeout_ms: 15000 responses: '201': description: The custom tool was created content: application/json: schema: type: object properties: data: type: object properties: id: type: string name: type: string description: type: string json_schema: type: object additionalProperties: true executor_url: type: string executor_secret_set: type: boolean enabled: type: boolean timeout_ms: type: integer confirmation: type: string enum: - never - always created_by_user_id: type: string nullable: true created_at: type: string format: date-time updated_at: type: string format: date-time meta: $ref: '#/components/schemas/ResponseMeta' 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_*) ````