Back to arky.io

Platform

Platform-level data — currencies, integration services, webhook events

The Platform module provides global configuration data used across all businesses.

Get Currencies

GET /v1/platform/currencies
SDK: sdk.platform.getCurrencies()

Get the list of supported currency codes.

const currencies = await sdk.platform.getCurrencies();
// ['USD', 'EUR', 'GBP', 'CAD', 'AUD', ...]

Get Integration Services

GET /v1/platform/integration-services
SDK: sdk.platform.getIntegrationServices()

Get the list of available integration provider types and their metadata.

const services = await sdk.platform.getIntegrationServices();

services.forEach(service => {
  console.log(service.type, service.category);
});

Get Webhook Events

GET /v1/platform/events
SDK: sdk.platform.getWebhookEvents()

Get the list of all available webhook event types.

const { data: events } = await sdk.platform.getWebhookEvents();
// ['node.created', 'node.updated', 'order.created', ...]