Webhooks

The URLs that are set must accept the POST request

Set Webhooks

POST https://api.jelou.ai/v1/widget/webhooks/

Headers

Name	Type	Description
apikey*	String

Request Body

Name	Type	Description
url*	String
events*	String[]

200: OK

{
  "message": [
    "Webhooks by <event> updated succesfully!"
  ],
  "statusMessage": "success",
  "status": 1,
  "data": {
    "webhooks": {
      "<event>": ["<urls>"]
    }
  }
}

Examples

curl --request POST \
  --url https://api.jelou.ai/v1/widget/webhooks \
  --header 'Content-Type: application/json' \
  --header 'apikey: <apikey>' \
  --data '{
	"url": "<URL valid>",
	"events": [
		"...",
		"<event-name>"
	]
}'

No authentication is currently supported for webhooks.

Get Webhooks

GET https://api.jelou.ai/v1/widget/webhooks/

Query Parameters

Name	Type	Description
event	String	Filter by event

Headers

Name	Type	Description
apikey*	String

200: OK

{
    // Response
  "message": [
    "Webhooks by <event> retrieved succesfully!"
  ],
  "statusMessage": "success",
  "status": 1,
  "data": {
    "webhooks": {
      "<event>": ["<urls>"]
    }
  }
}

Example

curl --request GET \
  --url 'https://api.jelou.ai/v1/widget/webhooks?event=<eventName>' \
  --header 'apikey: <apiKey>'

Delete Webhooks

DELETE ttps://api.jelou.ai/v1/widget/webhooks/

Headers

Name	Type	Description
apikey*	String

Request Body

Name	Type	Description
url*	String
event*	String

200: OK

{
  // Response
  "message": [
    "Webhooks by <event> deleted succesfully!"
  ],
  "statusMessage": "success",
  "status": 1,
  "data": {
    "webhooks": {
      "<event>": ["<urls>"]
    }
  }
}

Example

curl --request DELETE \
  --url https://api.jelou.ai/v1/widget/webhooks \
  --header 'Content-Type: application/json' \
  --header 'apikey: <apikey>' \
  --data '{
	"url": "<URL valid>",
	"event": "<event-name>"
}'

Event Types https://docs.jelou.ai/widget/widget-web/webhooks/events