Skip to main content
The Falconyte Public API is defined by the OpenAPI specification bundled with this documentation. The pages in this section are generated from that spec, so any updates to openapi.json are reflected automatically.

​
Welcome

The Falconyte Public API gives your integrations access to contacts, event ingestion, webhook management, campaign orchestration, email sending, and template management features. The reference pages in this section are grouped by domain:
  • Contacts API – manage email contacts, perform bulk actions, and retrieve unsubscribe activity.
  • Events API – ingest custom lifecycle events and review automated campaign decisions.
  • Webhooks API – configure outbound webhooks, inspect delivery history, and simulate payloads.
  • Campaigns API – create and manage event-triggered email campaigns, submit campaign events, and control campaign execution.
  • Emails API – send transactional emails with templates and dynamic content.
  • Templates API – create, update, and manage email templates for campaigns and transactional emails.
  • Mail Accounts API – retrieve available mail accounts for sending emails.
  • System – simple health check endpoint.

OpenAPI Specification

Open the machine-readable schema for the Falconyte Public API.

​
Authentication

All endpoints require an API key. Include the key issued to your workspace with every request: 
X-API-Key: <your-api-key>
Requests without a valid key receive a 401 Unauthorized response.