Skip to content

docs: align webhook and batch call guidance #44

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Ray-56 merged 1 commit into from
Sep 22, 2026
Merged

docs: align webhook and batch call guidance #44

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Changelog

## Unreleased

- Clarify request-level webhook configuration and purchased-number requirements for batch calls.

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@ or signature headers.

In scope:

- Create a call.
- Create a call, including multiple recipients when the account has an eligible
purchased number selected as its default outbound number.
- Read a call.
- Poll until a terminal call result.
- List call events.
Expand All @@ -57,7 +58,6 @@ In scope:
Out of scope:

- Async client support.
- Batch calls.
- Cancel calls.
- Recurring or scheduled calls.
- Goal authoring and publishing.
Expand Down
4 changes: 2 additions & 2 deletions openapi/calle.openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -644,7 +644,7 @@ paths:
tags:
- webhooks
summary: Server Message
description: CALL-E sends this request after a call reaches a terminal state and its post-call outcome and requested structured results are finalized. Configure this URL with `webhook_url` on create call or through project-level webhook settings.
description: CALL-E sends this request after a call reaches a terminal state and its post-call outcome and requested structured results are finalized. Configure your receiver URL with `webhook_url` when creating a call.
security: []
servers:
- url: https://{yourserver}
Expand Down Expand Up @@ -1175,7 +1175,7 @@ components:
additionalProperties: true
webhook_url:
type: string
description: Optional per-request HTTPS webhook URL. When provided, CALL-E sends terminal call events to this URL in addition to project-level webhook delivery.
description: Optional per-request HTTPS webhook URL. When provided, CALL-E sends terminal call events to this URL after result finalization.
format: uri
CallTaskRecipientRequest:
type: object
Expand Down
2 changes: 1 addition & 1 deletion src/calle/generated/models/create_call_request.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ class CreateCallRequest:
metadata (CreateCallRequestMetadata | Unset): Optional caller-owned metadata echoed on the call and webhook
payloads. Use this for workflow ids, tenant ids, or internal correlation keys.
webhook_url (str | Unset): Optional per-request HTTPS webhook URL. When provided, CALL-E sends terminal call
events to this URL in addition to project-level webhook delivery.
events to this URL after result finalization.
"""

task: str
Expand Down
Loading