Sign in

v57

latestOpenAPI 3.0.0W3C Software and Document Licenseraw.githubusercontent.com2026-08-01233665.9 KB
Interactions
Invite Request
Exchanges

Provides a location for a particular invitation response to be submitted to the by the entity trying to start an interaction. When an implementer has implemented the full specification, it is expected that the {inviteId} parameter will be equivalent to the {exchangeId}.

Ths endpoint is one of the ones expected to be included as a fully formed URL in the protocols object returned by the /interactions/{interactionId} endpoint.

post/{inviteId}/invite-request/response

Path parameters

string required
OR
integer required

The unique inviteId that the interaction requester uses to select the invite response protocol from the set of advertised options. When an implementer has implemented the full specification, this value will be an {exchangeId}, and that the invite-request/response endpoint lives on the Workflow Service.

Request body

urlstring required

A URL where the recipient can continue the interaction, should they choose.

purposestring required

A reason for the interaction that is human readable and usable in a concent interaction with the user recieving the inviteResponse object.

referenceIdstring required

An ID used to reference this particular inviteResponse, mostly for debug purposes.

Example request

{
  "url": "https://website.example/checkout/8372974",
  "purpose": "Checkout at ShopCo",
  "referenceId": "417bcaf2-14d9-11f0-99d7-9f094678517b"
}

Response

The inviteResponse object has been injested and was understood. This does not mean an interaction will continue, only that the inviteResponse was understood.