vodorod/Dorod-Sky
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

fix totp endpoint response schema (#619)

Browse Source
This commit is contained in:
Shuchang Zheng
2024-07-18 14:55:28 -07:00
committed by GitHub
parent f6108b95e0
commit 3e8afb4fdd
1 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/running-tasks/advanced-features.mdx
View File

@@ -25,7 +25,7 @@ Body:
Skyvern supports one-time password (see https://www.twilio.com/docs/glossary/totp for more information) by fetching it from your endpoint. You can pass `totp_verification_url` when [creating a task](/running-tasks/api-spec#request-initiate-a-task). Inside this endpoint hosted by you, you have to conform to the following schema: Skyvern supports one-time password (see https://www.twilio.com/docs/glossary/totp for more information) by fetching it from your endpoint. You can pass `totp_verification_url` when [creating a task](/running-tasks/api-spec#request-initiate-a-task). Inside this endpoint hosted by you, you have to conform to the following schema:
## Set Up Your TOTP Endpoint ### Set Up Your TOTP Endpoint
For websites that requires a verification code to complete a task, you have to set up a TOTP endpoint for Skyvern to fetch the verification code. For websites that requires a verification code to complete a task, you have to set up a TOTP endpoint for Skyvern to fetch the verification code.
Here's the TOTP endpoint contract you should use: Here's the TOTP endpoint contract you should use:
@@ -37,10 +37,11 @@ Request (POST):
Response: Response:
| Parameter | Type | Required? | Sample Value | Description | | Parameter | Type | Required? | Sample Value | Description |
| --- | --- | --- | --- | --- |
| task_id | String | yes | tsk_123 | The task ID that needs the verification to be done | | task_id | String | yes | tsk_123 | The task ID that needs the verification to be done |
| verification_code | String | no | 123456 | The verification code | | verification_code | String | no | 123456 | The verification code |
## Validate The Sender of The Request ### Validate The Sender of The Request
Same as the webhook API, your server needs to make sure it’s Skyvern that’s making the request. Same as the webhook API, your server needs to make sure it’s Skyvern that’s making the request.
- a python example for how to generate and validate the signature: - a python example for how to generate and validate the signature: