The automation run log, step by step
https://api.app2email.com/v1/{number}/submit/runs Scope: submissions:manage. Latest first, kept 30 days. Each run names its automation, submission and trigger and lists every step: the action, whether it worked, how long it took, and for outside calls the request that was sent and the start of the answer. Use status=failed to find what went wrong, status=waiting for runs paused by a wait or between retries. Page with next_cursor. An automation or submission filter that names nothing answers 404.
Path
-
Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.
e.g.4976659348270
Query
- automation integer
Only this automation's runs (its id).
e.g.31 - submission string
Only the runs on this submission (id or reference).
e.g.QR-4HT9XC - status string
Only this status.
runningokfailedwaitingskipped -
How many (1 to 200, default 50).
- cursor string
The next_cursor of the previous answer, unchanged. Leave out for the first page.
Responses
Fields
- success boolean
- request_id string
- runs object[]
13 item fields
- id integer
0 for a try: it is not stored.
- automation_id integer
- automation string
Its name.
- submission string
The submission's reference.
- trigger string
- status string
ok: it ran to the end; an action that did not work without stopping the run (a refused stage, a reply that could not be sent) has ok false in its step and its message in error. failed: an outside call ran out of retries, or failed with on_fail stop. waiting: paused by a wait action, between retries, or queued (due says when it continues). skipped: the conditions did not hold, or the automation or the submission was gone.
runningokfailedwaitingskipped - attempt integer
- steps object[]
9 item fields
- n integer
The action's number in the automation, counted from 1.
- type string
The action type.
- ok boolean
- ms integer
- summary string
What happened, in words.
- error string
- request object
Outside calls only: method, address and what was sent. Never a secret or a sign-in header.
- response object
Outside calls only: status and the first 2,000 characters of the answer.
- try integer
Only on a retry of an outside call: 2, 3 or 4.
- error string
- test boolean
true: a try, nothing was changed or sent.
- created string (date-time)
- finished string (date-time) | null
- due string (date-time) | null
- count integer
- next_cursor string
Pass it as cursor for the next page. Left out on the last page.
Errors
- 400 The request is malformed (missing or invalid fields, query parameters or times).
- 401 Missing, invalid, revoked or expired API key.
- 403 The key is valid but this call is not allowed: the key lacks the scope the call needs (insufficient_scope), the address is not allowed for the key (ip_not_allowed), the number or plan does not allow it, a recipient opted out or is not opted in, or a problem with the WhatsApp account.
- 404 The number, template, message, broadcast, webhook, delivery, opt-in, logged request, booking or Flow was not found.
- 429 A monthly plan limit, the number's own monthly cap, the key's daily cap, a WhatsApp rate limit, the API rate limit (rate_limited), or the webhook test limit (too_many_tests) was reached. Retry-After and error.retry_after_seconds say how long to wait.
- 500 Unexpected error on app2email's side.
- 503 app2email's connection to the WhatsApp account needs attention, or the request log is not available right now.