Skip to main content
Start a campaign flow for a customer the moment something happens in your own system. A marketer places an Inbound API block at the start of a flow in the Lobyco Admin Portal. The block gets a URL of its own. Your system, a CDP, a CRM or a POS, calls that URL with the customer’s id, and the customer enters the flow. It is the mirror of the OutboundAPI connection, which sends data out of a flow.
The Inbound API block is enabled per environment. If the marketer does not see it in the orchestration canvas, contact your Lobyco representative.

​
Before you start

  • A flow with an Inbound API block as its first block. The flow must be published, and the call must fall inside the block’s start and end window. The marketer’s side is on Block reference.
  • The block’s URL. The block’s configuration in the admin portal shows it, in the form https://integration.your-environment.lobyco.net/inbound/{id}.
  • The API key for the environment. Lobyco provides one key per environment, and it works for every Inbound API block there. Ask your Lobyco representative for a key, or to rotate one.
  • Valid Lobyco customer ids. Lobyco does not check the id against the customer base in this version, so send ids you know to be valid.

​
The flow

1

​
Send the request

POST https://integration.your-environment.lobyco.net/inbound/{id}Call the block’s URL with the API key in the API-KEY header and a JSON body:
The body carries two fields:
  • CustomerId, the Lobyco customer id to push into the flow. Required.
  • IdempotencyKey, a value of your choice that guards against duplicate calls. Optional, and recommended.
2

​
Read the response

A 202 Accepted with a requestId means Lobyco accepted the call and scheduled the flow for that customer. Keep the requestId. It is how you trace the execution with Lobyco. Any other status means the flow did not start; the codes are below.

​
Failure and edge cases

A call has worked when it returns 202 Accepted. The flow then runs for that customer, and what happens next is the flow’s own blocks.
  • Duplicate calls. Send an IdempotencyKey. A repeated call with the same key for the same block within 24 hours is ignored and returns the original requestId. A retry or an accidental double send therefore does not run the flow twice. A call without a key is always processed.
  • Retries are yours. Lobyco does not retry an inbound call. Retry on 429 Too Many Requests and on network errors, with the same IdempotencyKey.
  • One customer per call. Each request runs the flow for one CustomerId. Batch calls are not supported yet.
  • No extra payload. Lobyco reads only CustomerId and IdempotencyKey. Other properties are ignored for now.
  • Keys come from Lobyco. Self-service key management and request logs are planned for later.
  • OutboundAPI connection — the other direction, where a flow calls an endpoint in your system.
  • Block reference — what the marketer configures on the Inbound API block.
  • Events — the payloads a flow can send on through the OutboundAPI connection.
Last modified on October 9, 2026