Register a new webhook endpoint

PUT /r/wh/1/webhook

OAuth2

Register a webhook endpoint

application/json

Body Required

endpointId string Required

The unique endpoint ID for example you can use your company name
password string

he password for basic auth
url string Required

The endpoint URL
username string

The username for basic auth
withBasicAuth boolean

If basic auth should be used, defaults to false

Responses

• 200 application/json

OK
Hide response attributes Show response attributes object
- endpointId string Required
  
  The unique endpoint ID for example you can use your company name
- password string
  
  he password for basic auth
- url string Required
  
  The endpoint URL
- username string
  
  The username for basic auth
- withBasicAuth boolean
  
  If basic auth should be used, defaults to false
• 400 */*

Bad Request
Hide response attributes Show response attributes object
- status string
  
  Value is 400.
- timestamp string(date-time)
- message string
- apiSubExceptions array[object]
  
  Hide apiSubExceptions attributes Show apiSubExceptions attributes object
  
  field string
  
  rejectedValue string
  
  message string
• 403 */*

Forbidden
Hide response attributes Show response attributes object
- status string
  
  Value is 403.
- timestamp string(date-time)
- message string
- apiSubExceptions array[object]
  
  Hide apiSubExceptions attributes Show apiSubExceptions attributes object
  
  field string
  
  rejectedValue string
  
  message string

PUT /r/wh/1/webhook

curl \
 -X PUT https://api.lsk.lightspeed.app/r/wh/1/webhook \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"endpointId":"string","password":"string","url":"string","username":"string","withBasicAuth":true}'

Request example

{
  "endpointId": "string",
  "password": "string",
  "url": "string",
  "username": "string",
  "withBasicAuth": true
}

Response examples (200)

{
  "endpointId": "string",
  "password": "string",
  "url": "string",
  "username": "string",
  "withBasicAuth": true
}

Response examples (400)

{
  "status": "400",
  "timestamp": "2024-05-04T09:42:00+00:00",
  "message": "string",
  "apiSubExceptions": [
    {
      "field": "string",
      "rejectedValue": "string",
      "message": "string"
    }
  ]
}

Response examples (403)

{
  "status": "403",
  "timestamp": "2024-05-04T09:42:00+00:00",
  "message": "string",
  "apiSubExceptions": [
    {
      "field": "string",
      "rejectedValue": "string",
      "message": "string"
    }
  ]
}