GET/api/v1/hooks

Get Hooks

Hooks or Webhooks are user-defined HTTP callbacks or endpoints that allow applications to send real-time notifications or data to a specified URL when a particular event or trigger occurs.

This API provides a list and details of all user hooks. Users can access this endpoint to obtain details about each hook, including the hook username, userid, authtype and other relevant information. Upon a successful request, the system will respond with a JSON object containing all information of all hooks.

GET/api/v1/hooks

Parameter Details

Name	In	Type	Required	Description
`page`	query	`integer`	Optional	The page number to retrieve.
`size`	query	`integer`	Optional	The number of items to be displayed per page.

Responses

Status	Meaning	Description	Schema
200	OK	Success
400	Bad Request	Request data failed validation(s)	None
401	Unauthorized	Authentication Failed!	None
429	Too Many Requests	Too Many Requests.	None
500	Internal Server Error	Internal Server Error	None

Example Request

# You can also use wget
curl -X GET /api/v1/hooks \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

Example responses

200 Response

{
  "error": false,
  "hooks": [
    {
      "_id": "63ff246fb2482db1c660e310",
      "_user": "63fda531bde67155fc46fb41",
      "userName": "user@flightrates.com",
      "endPoint": "//latest",
      "authType": "Personal",
      "userId": "RM123",
      "pwdTxt": "uuxx",
      "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6I",
      "hookType": "dbs",
      "isActiveStatus": true,
      "_shop": "63fdc414cccc3592d31b3ac8",
      "vertical": "flightrates",
      "isCustomerCreated": true,
      "id": "63ff246fb2482db1c660e310"
    }
  ],
  "totalData": 1,
  "totalPages": 1,
  "page": 1,
  "size": 1
}

PreviousCreate Hook

NextGet Hook

Need Support?

Our team is here to help you integrate and make the most of our APIs. Get in touch for technical support, custom solutions, or any questions.

Contact Support

About Us