API para Desenvolvedores

Construa sobre a camada de mensageria Verbum.

Uma API REST JSON para criação de rascunhos, solicitação de aprovações, roteamento de mensagens e assinatura de eventos webhook — com contexto de tenant e trilha de auditoria completa.

Request API accessView plansBook demo

OVERVIEW

Designed for controlled server-side integrations.

The Verbum API is positioned for approved B2B implementation projects where messaging automation must remain governed. API-triggered workflows use the same approval layer, tenant boundaries and audit history expectations as the Verbum console.

Endpoint disclosure

Private until scope is approved

Endpoint paths, schemas and credential formats are withheld from self-service materials.

Availability

Guided technical onboarding

Webhooks/API hooks start on Pro; REST API starts on Business through private guided onboarding.

Access model

Approved workspace scope

Access is reviewed against plan, security expectations, workspace permissions and rollout readiness.

Access by plan

Pro

Surface
Webhooks/API hooks
Scope
Webhooks/API hooks and CRM/help desk connector paths.

Business

Surface
REST API
Scope
REST API eligibility and custom system integration paths.

Enterprise

Surface
Advanced review
Scope
Advanced implementation, custom capacity, procurement and security review.

Starter

Surface
Not included
Scope
No CRM/help desk connector paths, Webhooks/API hooks, REST API or custom system integrations.

Webhooks and API hooks are available from Pro through private beta or guided technical onboarding. REST API remains in private beta and starts on Business through private guided onboarding. Verbum does not offer a public self-service API or public OpenAPI contract from this page.

DEVELOPER ONBOARDING

A guided path from access request to go live.

The API path is intentionally reviewed before production use so technical teams can validate scope, governance, security and rollout readiness without assuming public self-service access.

  1. Starts from the contact flow

    Request access

    Share the workflow, plan context, systems involved and whether you need Webhooks/API hooks, REST API scope or a custom system path.

  2. Eligibility and scope check

    Review

    Verbum reviews fit, security expectations, provider constraints and governance requirements.

  3. Guided technical setup

    Onboarding

    Approved teams align authentication, scopes, signing, event families and ownership.

  4. Governance and reliability review

    Validation

    Validate approved flows against review gates, failure handling, audit history expectations and operational readiness before production use.

  5. Production readiness

    Go live

    Move to production only after rollout responsibilities, monitoring and escalation paths are clear.

IMPLEMENTATION BLOCKS

What technical teams can evaluate before access is approved.

These blocks summarize the developer onboarding surface without publishing endpoint paths, command examples, credential formats or schema contracts.

AuthenticationBeta privado

Credential details are shared with approved server-side implementers.

Minimum plan
Business for REST API scope; Pro for Webhooks/API hooks
Setup mode
Guided review
Governance behavior
Least-privilege scopes and server-side credential handling
WebhooksGuided access

Event families, signing expectations and delivery handling are reviewed for the workspace.

Minimum plan
Pro, Business and Enterprise
Setup mode
Private beta or guided onboarding
Governance behavior
Events reflect governed workflow states without bypassing approvals
API AccessBeta privado

REST API scope is evaluated for Business and Enterprise implementation paths.

Minimum plan
Business and Enterprise
Setup mode
Private guided onboarding
Governance behavior
API-triggered work stays subject to Verbum Sense, Verbum Assist, Verbum Automate and audit controls
Developer onboardingAvailable upon request

Implementation support focuses on scope, validation, rollout readiness and ownership.

Minimum plan
Eligible paid plans based on requested surface
Setup mode
Guided review
Governance behavior
Validation covers approval paths, failure handling and traceability
Request API accessBook demo

COMMON INTEGRATION PATTERNS

Practical patterns for governed messaging integrations.

These patterns explain how teams commonly evaluate Verbum developer access. They are not final endpoint, schema or availability commitments.

Illustrative

CRM/contact sync

Use approved customer or contact context to support AI-assisted drafts and routing decisions.

Governance layer

Context enters Verbum without bypassing approval paths or workspace controls.

Illustrative

Approval status events

Notify downstream systems when drafts move through review, approval or rejection states.

Governance layer

Reviewers, timestamps and routing context remain traceable where enabled.

Illustrative

Message lifecycle events

Connect internal systems to high-level draft, approval and delivery lifecycle changes.

Governance layer

Event coverage is confirmed during onboarding for the approved workspace scope.

Illustrative

Internal workflow automation

Trigger governed workflows from internal tools while keeping Verbum Assist review and Verbum Automate guardrails in place.

Governance layer

Automation should respect configured rules, roles and escalation paths.

Illustrative

Audit exports

Review audit-history access for reporting or control evidence when supported by plan, role and workspace configuration.

Governance layer

Exports are scoped during onboarding and should not be assumed available for every workspace.

ILLUSTRATIVE WEBHOOK EVENTS

Example event names for planning conversations.

The event names below are illustrative. Final event names, schemas, signing behavior and delivery guarantees may vary by approved scope and are confirmed during onboarding.

  • Webhook event

    Illustrative
    Event name
    draft.created
    Meaning
    A governed draft workflow was created.

  • Webhook event

    Illustrative
    Event name
    draft.approved
    Meaning
    A draft passed the configured approval path.

  • Webhook event

    Illustrative
    Event name
    message.sent
    Meaning
    A message was sent through an approved channel workflow.

  • Webhook event

    Illustrative
    Event name
    approval.rejected
    Meaning
    A reviewer rejected or returned a draft for changes.

  • Webhook event

    Illustrative
    Event name
    audit.event.created
    Meaning
    A traceable workflow event was recorded where audit history is enabled.

EXAMPLE ERROR MODEL

Error categories integrations should be ready to handle.

This model is illustrative for evaluation. Final response bodies, retry guidance and error details are confirmed during technical onboarding.

  • HTTP 400

    HTTP status
    400
    Código de erro
    validation_error
    Quando ocorre
    The request shape, required field or business rule did not pass validation.

  • HTTP 401

    HTTP status
    401
    Código de erro
    unauthorized
    Quando ocorre
    Authentication is missing, invalid or not accepted for the approved integration.

  • HTTP 403

    HTTP status
    403
    Código de erro
    forbidden
    Quando ocorre
    The credential or workspace role is not allowed to perform the requested action.

  • HTTP 429

    HTTP status
    429
    Código de erro
    rate_limited
    Quando ocorre
    The integration exceeded the rate limit or operational guardrail confirmed for its scope.

  • HTTP 500

    HTTP status
    500
    Código de erro
    server_error
    Quando ocorre
    An unexpected service error occurred; retry and escalation guidance is confirmed during onboarding.

ENDPOINT STATUS

Endpoint paths are private until scope is approved.

Verbum does not publish unconfirmed endpoint paths or a public OpenAPI asset. The matrix below documents the current API surface without inventing paths, client libraries or credential formats.

Examples are provided for planning and may be adjusted during implementation.

Endpoint surface status by areaPrivate disclosure status, availability and notes for each developer surface.
Surface areaEndpoint disclosureStatusAvailabilityNotes
Authentication and scopesPrivate disclosureBeta privadoBusiness and EnterpriseServer-side credentials, least-privilege scopes and workspace-level access are reviewed before use.
Core resourcesPrivate disclosureBeta privadoBusiness and EnterpriseGoverned drafts, approvals, channels and audit access are scoped to the approved implementation.
Webhook deliveryPrivate disclosureGuided accessPro, Business and EnterpriseEvent types, delivery status, signing, event type coverage, and retry expectations are confirmed for approved use cases.
OpenAPI specificationsNo public downloadAvailable during approved onboardingApproved onboarding onlyNo public OpenAPI contract is offered as a self-service asset. Private implementation materials are provided during approved onboarding where available.

SECURITY

Security controls expected for API and Webhooks.

API access is governed by customer plan, workspace permissions, approved implementation purpose and technical onboarding.

  • Signed webhooks for approved event subscriptions.
  • Scoped access governed by plan, workspace permissions and implementation purpose.
  • Audit history for API-triggered drafts, approvals and delivery events where enabled.
  • Approval-aware automation: API-triggered workflows do not bypass Verbum Assist or Verbum Automate guardrails.
  • Server-side usage only; credentials should never be exposed in browser bundles.

OPENAPI

OpenAPI availability

No public OpenAPI asset is promised from this page. Private implementation materials are provided during approved onboarding where available for the confirmed scope.

This page does not create a public self-service API contract, endpoint roadmap or SDK commitment. Final implementation materials are confirmed only for approved scopes.

Explore mais

CONSTRUA COM O VERBUM

Request private API access.

Request API access for a guided review of your integration goals, security requirements and implementation path.

Request API accessView plansBook demo