Version: 3.0
Connxio API
Introduction
This API is documented in the OpenAPI format and provides users with programmatic access to the Connxio platform, allowing them to interact with and control various aspects of their integrations and workflows. With the Connxio API, users can automate integration processes, manage configurations, and programmatically interact with the messaging capabilities, providing flexibility and customization options for seamless integration with their existing systems.
Versioning
Both the Connxio API and Custom APIs uses versioning. The newest version of an endpoint is the one with the highest number for its type. Please browse the documented versions to find the desired endpoint.
Cross-Origin Resource Sharing
This API features Cross-Origin Resource Sharing(CORS) implemented in compliance with the W3C spec which allows for cross-domain communication from the browser. All responses have a wildcard same-origin policy.
Authentication
The Connxio API offers two forms of authentication:
The API Key is required for all requests to the API. The OAuth2 authentication is implemented using the Client Credentials Flow and is strongly recommended for all requests to the API.
Authentication
- API Key: Connxio-Api-Key
- API Key: Connxio-Api-key
- API Key: Connxio-Api-Webhook
- HTTP: Bearer Auth
API Key for Connxio API. Can also be set using a query parameter. If using the webhook functionality, the header 'Connxio-Api-Webhook' must also be set to 'true'
Security Scheme Type: | apiKey |
---|---|
Header parameter name: | Connxio-Api-Key |
API Key for Connxio API as a query parameter. Only use if headers are unavailable to you.
Security Scheme Type: | apiKey |
---|---|
Header parameter name: | Connxio-Api-Key |
This header must be set to 'true' to enable webhook functionality for the API key
Security Scheme Type: | apiKey |
---|---|
Header parameter name: | Connxio-Api-Webhook |
JWT Authorization header using the Bearer scheme.
Security Scheme Type: | http |
---|---|
HTTP Authorization Scheme: | bearer |