Create a follow-up
Wait for something to arrive somewhere, or check back later.
where is the place, match what counts as arrived, within how long to wait, all explained in Follow-ups. Durations are strings such as 15m, 2h, 1h30m, 10 minutes, or a number of seconds.
The answer is the follow-up as waiting, with its id. Nothing calls you back: poll Get a follow-up until status is done. For kind: time, leave match and check_every out.
Creating twice makes two waits, so send an Idempotency-Key to make a retry safe. See Idempotency.
create_followup.Authorizations
API key with the vd_sk_ prefix, as Authorization: Bearer vd_sk_.... Create keys in Settings → API Keys.
Headers
Any unique string (such as your order id). Resending the same request with the same key within 24 hours returns the first answer (with Idempotent-Replayed: true) and does nothing twice; the same key with a different request is a 422 idempotency_key_reused.
1 - 255Body
What you are waiting for, in plain words: shown to the user and read back with the outcome, e.g. 'the sign-in code from greenhouse.io'.
1 - 500How long to wait (or when to check back): '90s', '15m', '2h', '1d', '1h30m', '10 minutes', or a number of seconds. At most 72 hours.
"15m"
Not with kind time.
How often to look, '90s', '15m', '2h', '1d', '1h30m', '10 minutes', or a number of seconds; at least 30 seconds. Default: what suits the place (an inbox is told on arrival; a web page is read every few minutes). Not for time.
"15m"
Response
The follow-up, waiting. Poll GET /v1/followups/{followup_id} for its outcome.
Who is waiting: api for one made here; igris, session or brain for one an in-app agent made.
igris, session, brain, api waiting: timed and checked. done: ended (outcome says how). cancelled. failed: could not be checked (note says why).
waiting, done, cancelled, failed The session or workflow of an in-app agent; empty here.
found: it arrived (found holds it). time_up: a check-back's time came. expired: nothing came in time.
found, time_up, expired The thing that arrived — only it, never the rest of the mailbox.
One plain line on how it ended.
Only things that arrived after this count.
How many times the place was looked in.

