MOmodjo
Webhooks

Create a webhook

Changed on

Creates a new webhook. Name must be unique within the tenant.

post/webhooks

Request

  • Base URL
    https://api.modjo.ai/v2
  • URL
    https://api.modjo.ai/v2/webhooks
  • Auth
    HTTP bearer

Request body

namestring required

Webhook name. Must be unique within the tenant.

urlstring uri required

HTTPS URL where event payloads will be delivered

Example request

{
  "name": "Call Summary Notifications",
  "url": "https://example.com/webhooks/modjo",
  "events": [
    "call_summarized"
  ]
}

Response

Webhook created

uuidstring uuid required

Webhook UUID

namestring required

Webhook name

urlstring required

Webhook delivery URL

createdOnstring nullable required

Creation timestamp in ISO 8601 format

modifiedOnstring nullable required

Last modification timestamp in ISO 8601 format

Example response

{
  "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "My Webhook",
  "url": "https://example.com/webhook",
  "events": [
    "call_summarized"
  ],
  "createdOn": "2024-06-15T14:30:00.000Z",
  "modifiedOn": "2024-06-15T15:00:00.000Z"
}

Changes

  • 9d2a0a6a5a20Revision changes
    • warning

      added the new agent_run_finished enum value to the // response property for the response status

    • info

      added the new agent_run_finished enum value to the request property //