Description: Api to assign ticket to an agent or admin HTTP Method : PATCH URL : v3/ticket/assign Content-Type: application/json Name Data Type Required / Optional Description assigned_to string Required takes two values => 1. user_{user_id} => if you want to assign to an agent or yourself, in this case replace user id with the […]
Category: Internal API
Handling widgets
Faveo widgets allow admin to add social media icons and custom footer widgets in the client panel. The APIs are exclusively accessible by Admin users. Both social media icons and footer widgets can be accessed via the same API by just passing type slug to inform the system which widget record we want to access. Get widget […]
How to pass OAuth2 token in API version 3
Faveo API version 3 uses OAuth token to grant access to the API endpoints which require user authentication. If you call an API that requires authentication without passing the OAuth token it will return the below response with HTTP status code 422. { “result”: { “fails”: “Unauthorized! Please login again” } } Note: Faveo API […]
Sla CRUD
Get SLA URL : v3/api/get-enforcer/sla/{slaId} Method : GET Response : { “success”: true, “data”: { “sla”: { “id”: 84, “name”: “Test Sla”, “status”: 1, “order”: 1, “matcher”: “all”, “is_default”: 0, “internal_notes”: “”, “created_at”: “2019-12-09 11:12:15”, “updated_at”: “2019-12-09 11:12:15”, “sla_meta”: [{ “id”: 14, “ticket_sla_id”: 14, “priority_id”: 1, “respond_within”: “diff::1~hour”, “resolve_within”: “diff::1~hour”, “business_hour_id”: 1, “send_email_notification”: 1, “send_app_notification”: […]
SLA reminders
NOTE: These API is going to change in near future. Not meant for extenal purpose for now Gets SLA Reminders URL : v3/api/admin/sla-reminders/slaId Method : GET Response : { “id”: 58, “reminders”: { “approach”: [{ “id”: 1, “reminder_delta”: 10, “reminder_receivers”: { “agents”: [{ “id”: 1, “name”: “demo admin” }], “agent_types”: [{ “id”: 1, “name”: “Department […]
Form Group
URL : v3/api/post-form-group Method : POST Query Parameters : None Body Parameters : Parameter Type Possible values Optional/Required Description name string Required Name of the form group form-fields array Array of objects Required Form fields which are updated or newly created. Please read below for detailed explanation help_topic_ids array Optional array of help topic […]
Login
Description: Authenticates a user and gives his/her profile information back if successful. URL: v3/api/login Method: POST Response Format: JSON Parameters : Name Data Type Required / Optional Description user_name String Required Username of the agent email String Required Email address of the agent password String Required Password of the agent Note: Only one parameter—either user_name […]
Refresh Token
URL: v3/api/refresh Method: get Response Format: JSON Parameters: Name Data Type Required / Optional Description token String Required Old token Success Response { “success”: true, “data”: { “token”: “eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjEsImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODAwMC9hcGt3uPtvQARsvo” } }
Logout
URL: v3/api/logout Method: get Response Format: JSON Parameters: Name Data Type Required / Optional Description token String Required token Success Response { “success”: true, “message”: “Successfully logged out” }
Social login redirect
URL: v3/api/social/login/redirect/{provider} Method: get Response Format: Redirect Description: Provider name has to be provided by frontend for the backend to authenticate based on the given provider. Parameters: None