API Reference
  1. Workflows
  2. Integration Command

Post an integration command's result.

post
https://api.podium.com/v4/integration_commands//result

Post the outcome of a claimed command.

Answers 204 when the result is stored. Posting again under the same claim_token also answers 204 and changes nothing, so a result whose answer was lost can be posted again. 409 means the claim token no longer holds the command: the claim expired, or the command was claimed again. 404 is an unknown command. 400 means the body is invalid; posting it again will not change the answer. A succeeded outcome carries result; a failed one carries error_code.

Note: This route requires that your application gets allow-listed. See: KumeteWeb.Plugs.RateLimitV4 for reference. If you need to add a new application to the allow-list, please contact the team responsible for Kumete [marketplace-team].

Required scope: write_integration_commands.

Path Params
uuid
required

Podium unique identifier for command.

Body Params

Result params

string
required
length ≥ 1

The claim_token the command came with.

string | null

Why the command failed, e.g. outcome_unknown, in at most 64 characters. Required when status is failed.

uuid
required

Podium unique identifier for location the command is for.

string | null

A human-readable description of a failure, without customer data.

boolean | null

true when the outcome was answered from the agent's ledger for a retried command.

result
object | null

The operation's answer. Required when status is succeeded.

string
enum
required

Whether the command succeeded.

Allowed:
Responses
204

The result was stored, or was already stored under this claim token.

404

No such command.

409

The claim token no longer holds the command.

Callback

Updated 3 days ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 days ago

Did this page help you?