GET/api/v1/hook/{hooksId}

Get Hook

This API provides details of a specific user hook. By providing the hook ID in the request, users can obtain details about the hook, including the hook username, userid, authtype and other relevant information.
GET/api/v1/hook/{hooksId}

Mandatory Fields

  • hooksId

Parameter Details

NameInTypeRequiredDescription
hooksIdpathstring(string)Requirednone

Responses

StatusMeaningDescriptionSchema
200OKSuccess
400Bad RequestRequest data failed validation(s)None
401UnauthorizedAuthentication Failed!None
404Not FoundNot found.None
429Too Many RequestsToo Many Requests.None
500Internal Server ErrorInternal Server ErrorNone

Example Request

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

Example responses

200 Response
{
  "error": false,
  "hook": {
    "_id": "63ff246fb2482db1c660e310",
    "_user": "63fda531bde67155fc46fb41",
    "userName": "user@flightrates.com",
    "endPoint": "//my-hook",
    "authType": "jwt",
    "userId": "63fda531bde67155fc46fb4",
    "pwdTxt": "demo1",
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6I",
    "hookType": "dbs",
    "isActiveStatus": true,
    "_shop": "63fdc414cccc3592d31b3ac8",
    "vertical": "flightrates",
    "isCustomerCreated": true,
    "id": "63ff246fb2482db1c660e310"
  }
}

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.