Quickstart

You’ll need an API key from Settings.

Create an Action

Actions define the work your platform performs. Create one on the New Action page with the variant orders.created.

Add an SDK destination

Create an SDK destination on the Destinations page: set Destination Type to SDK and enter the namespace quickstart. Other destination types deliver over HTTP or to Pub/Sub.

Link them

Open the action’s Flow tab and use Link destination to attach the newly created SDK Destination.

Start a listener

The listener claims deliveries for its namespace and hands each one to your handler.

TypeScript
Python

import Listener from "@arklow/sdk-ts/listener";

const listener = new Listener({ apiKey: process.env.ARKLOW_API_KEY! });

const running = listener.listen(
  { namespace: "quickstart" },
  async (delivery) => {
    console.log(delivery.variant, delivery.payload);
    await delivery.ack();
  },
);

The package arklow-sdk-py imports as arklow.

import asyncio
import os

from arklow import Listener


async def main() -> None:
    listener = Listener(api_key=os.environ["ARKLOW_API_KEY"])

    async def handle(delivery) -> None:
        print(delivery.variant, delivery.payload)
        await delivery.ack()

    listener.listen(handle, namespace="quickstart", max_outstanding=16)
    await asyncio.Event().wait()


asyncio.run(main())

ack() settles the action as succeeded. A handler that returns without settling acks; an unhandled error nacks, and the attempt is redelivered.

Send work

One POST to ingress creates the action.

curl -X POST https://ingress.arklow.io/v1/ingress/orders.created \
  -H "X-Arklow-Auth: $ARKLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"order_id": "8471", "total": 129.50}'

SQS and Pub/Sub sources ingest into the same action from queues you already run.

Acknowledge the Action

When your handler finishes its work, it automatically acknowledges. If the work should be handled asynchronously, see Deferring work.

Getting started

Fundamentals

Next steps

SDK

How Arklow works

​Next steps

SDK

How Arklow works

Next steps