Overview & Auth

Octany API

Looking to integrate with Octany? We've got everything you need here.

Where do I start?

Want to get started with Widget integration?

1. Widget examples

Want to get started with API integration? Here's a quick check list:

1. Get your API token
2. Access data via our endpoints
3. Subscribe to our webhooks
4. Have a question? Send us an email

Authentication

Generate your API token by logging in to Octany and you'll find API tokens in Settings

When making an API call, add your token as a X-API-Key header. Example cURL call:

curl "https://app.octany.com/api/[ACCOUNT_ID]/subscriptions" \
     -H 'X-API-Key: [TOKEN]'

Replace [ACCOUNT ID] with your Octany account id and [TOKEN] with your API token.

Endpoints

Call our API endpoints when you want to get customers or subscriptions.

↳ View all endpoints

Webhooks

We recommend listening for webhooks for all integration. We will send a JSON POST every time something happens within Octany.

↳ View all webhooks