Developers
Custom connectors and webhooks
Send normalized source records, authenticate safely, and process webhook outcomes.
- Audience
- developers
- Required role
- Developer with API key management and source-system access.
- Product access
- Developer API
- Navigation path
- Developer Hub, API Reference, and Settings > API keys
Outcome
Implement a custom source connector that sends valid records and handles errors without losing source identity.
Before you begin
- A scoped API key
- Stable external record IDs
- The source record schema and provider mapping
Choose the contract
Use the current source-record batch schema and OpenAPI specification. Map source type, external ID, title, body, timestamps, account hints, and source URL without embedding provider credentials.
Authenticate
Send the scoped bearer token over HTTPS and keep it in a secret manager. Use separate keys for environments and rotate without reusing an exposed value.
Send records
Batch within documented limits, preserve stable external IDs for idempotency, and validate the response for accepted and rejected records. Retry only transient failures with backoff.
Handle errors and webhooks
Treat validation failures as permanent until the payload changes. Verify webhook signatures when supported, store delivery IDs for deduplication, and monitor API changelog and status information.
Related guides
API Reference
Browse authentication, abilities, endpoints, schemas, and examples.
API keys, security, retention, and export
Control API credentials, account security, data retention, and organization exports.
Status glossary and troubleshooting index
Interpret common states and choose the right recovery guide before contacting support.