Approval service
Overview
The Approval service enables products to implement standard request-and-approval flows within the Console portal. It allows users to submit requests, routes them to designated approvers, and supports automated post-approval actions.
Requests can be approved or rejected via email or portal. Both requestors and approvers receive email updates throughout the process.
💡 This service is commonly used for product workflows that require delegated approval from specific users or roles.
Request workflow
The diagram below shows the full lifecycle of an approval request.
Create a request
Requests are created via the Approval service API. Once submitted, approvers are notified to approve or reject the request.
💡 For API fields and structure, see the API specifications.
What to expect:
- An email is sent to all listed approvers.
- The requestor cannot be one of the approvers.
- You can define multiple approvers, but only one approval is required.
- Approvals can be made through either:
email– reply directly to the emailportal– via the Console portal
- Certain fields in the request payload affect what is displayed in the portal.
⚠️ Do not assign the same user as both requestor and approver. This will cause the request to fail validation.
Approve or reject a request
You can specify one or both approval channels (email or portal) when the request is created.
Email channel
- Approvers reply to the email to approve or reject the request.
- If an invalid reply is sent (for example, using the wrong keyword), they will receive a follow-up email asking them to retry.
⚠️ Approval emails must follow the correct reply format to be processed successfully.
Portal channel
- Approvers can approve or reject requests via your integrated web application.
- Requests are visible on the Approvals page.
- A notification will also appear on the Notifications page.
💡 You may use the Approval service API to build your custom portal interface for approvals.
If both channels are provided, the approver may use either to respond.
Request status updates
Each time a request status changes, a TechPass webhook is triggered.
Your product can subscribe to this webhook to be notified of all updates.
For details on webhook setup, see the TechPass guide.
Email updates
Requestor notifications:
- Request created
- Request approved or rejected
- Request cancelled
- Request marked as failed or completed
Approver notifications:
- New request to approve
- Reminder to approve the request
- Approval or rejection failed and needs retry
- Approval or rejection succeeded
- Request was cancelled
See Approval emails (sample) for examples.
Request reminders
The Approval service can send email reminders if a request is not approved after a specified number of days.
This setting can be configured in the Console Portal.
💡 Reminders are sent once per day, for up to five working days.
Demo
To explore how the approval flow works, try our sample application hosted on the Console.
