HTTP Ingress

Ingress is the direct path into Arklow over HTTP.

POST https://ingress.arklow.io/v1/ingress
POST https://ingress.arklow.io/v1/ingress/{action}

When specifying the action in the URL - Arklow will consider the payload to be as-is. Any configuration properties should provided as a Query String. This is useful for platforms that won’t allow you to configure the payload of a request.

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

Any tag.<key>=<value> query parameter merges over the body’s tags, and the tags select the lane the action dispatches through. The response carries the action’s id as a_id, already queued. Every accepted POST creates a new action: When omitting the action in the URL, Arklow will expect you to provide the necessary details about the Action, including

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

The HTTP ingress has special concerns for duplicate actions that we receive. Please see Source Deduplication for more information.

Getting started

Fundamentals

Reference

API Reference

​Reference

API Reference

Reference