Skip to documentation
Asteri/Developers

Developer Search

Search developer docs, public resources, and endpoint references.

Get started

  • Overview
  • Quickstart

Build

  • API basics
  • API reference
  • TypeScript SDK
  • Webhooks

Manage

  • Integration setup
  • Changelog

REST API v1

OpenAPI specificationContact Asteri

Build an integration

Integration setup

Manage the connection in your CRM, then use these guides to build and test your integration.

On this page
Manage the connectionBuild the integrationBefore going live

Start in your CRM

API keys, request activity, and webhook endpoints are in Security settings under Developer. Your CRM role and plan determine which controls you can use.

Open developer settings
API keys
Create a key, choose its permissions, and set its expiry and request limits.
Request activity
Review recent requests, response statuses, and latency for your keys.
Webhook endpoints
Manage the addresses that receive updates from your CRM and review delivery activity.

One key, one company

Each API key belongs to one company in Asteri. Keep full keys on your server and give each integration only the permissions it needs.

Build the integration

Make your first requestCreate a scoped key and read customers from your CRM.Find an endpointBrowse request fields, response examples, and required permissions.Use the TypeScript SDKCall the API with the generated client.Receive CRM updatesVerify signed events and handle deliveries safely.

Before going live

  • Choose the smallest set of key permissions your integration needs.
  • Keep keys and webhook signing secrets out of browser code and public repositories.
  • Handle rate limits and errors, and send an idempotency key when an endpoint requires one.
  • Verify webhook signatures and make repeat deliveries safe to process.
Asteri developer documentation · View changelog