Skip to content

Latest commit

History

History
21 lines (16 loc) · 1.77 KB

File metadata and controls

21 lines (16 loc) · 1.77 KB

CreatePromptRequest

Properties

NameTypeDescriptionNotes
userStringThe user to send the approval request to. Can be either an email address or a phone number.
bodyStringThe body of the approval request to show the user.
titleStringThe title of an approval request. Defaults to an empty string.[optional]
approveTextStringThe approve action text. Defaults to 'Approve'.[optional]
approveRedirectUrlStringAn HTTPS URL to redirect the user to if the prompt is approved. This URL is kept secret until the user is redirected to it.[optional]
rejectTextStringThe reject action text. If not specified the reject button will NOT be rendered, and the user will only see an approve action button.[optional]
rejectRedirectUrlStringAn HTTPS URL to redirect the user to if the prompt is rejected. This URL is kept secret until the user is redirected to it.[optional]
longPollBooleanIf true, the request waits (long-polls) until the user responds to the prompt or more than 10 minutes pass. Defaults to false.[optional]
expiresInBigDecimalThe number of seconds until this request can no longer be answered.[optional]
metadataPromptMetadata[optional]
internalDataMap<String, String>[optional]
idempotencyKeyStringAllows calling `create_prompt` multiple times idempotently, such that a prompt is sent at-most once. This key should contain sufficient randomness. Idempotent requests are stored for 24 hours. After that time, the same key will create a new request.[optional]