POST/api/v1/hook

Create Hook

POST/api/v1/hook

Parameter Details

NameInTypeRequiredDescription
bodybodyhooksPostReqRequirednone

Responses

StatusMeaningDescriptionSchema
200OKSuccessschemahookspostresp
400Bad RequestRequest data failed validation(s)
401UnauthorizedAuthentication Failed!
429Too Many RequestsToo Many Requests.
500Internal Server ErrorInternal Server Error

Example Request

# You can also use wget
curl -X POST /api/v1/hook \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

Body parameter

{
  "endPoint": "//my-hook",
  "authType": "jwt",
  "userId": "63fda531bde67155fc46fb4",
  "pwdTxt": "uuxx",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6I",
  "hookType": "dbs",
  "isActiveStatus": true,
  "_shop": "63fdc414cccc3592d31b3ac8"
}

Example responses

200 Response
{
  "error": false,
  "hook": {
    "_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.