Subscriptions

When massive messages are sent using HSM, notifications can be generated so that you can subscribe to that relevant information and your team can manage this data of each message using webhooks.

Webhook is a method for one system to notify another system or application about events or updates in real time. Firstly, you should verify if there are any subscriptions configured to be sure that it is already set in your bot or not in order not to duplicate subs. Afterward, you can subscribe to events you need.

Get Subscriptions

GET https://api.jelou.ai/v1/bots/:botId/events/webhook

This endpoint allows you to get information from previous subscriptions

Path Parameters

Name	Type	Description
botId	string	ID of the Bot.

Headers

Name	Type	Description
Authentication	string	Authentication token to track down who is emptying our stocks.

200 Webhooks successfully retrieved.

{
	"message": [
		"Webhooks retrieved successfully!"
	],
	"statusMessage": "success",
	"status": 1,
	"data": {
		"read": "https://webhook.site/379dd1bd-a753-499d-b9dd-23979020bcd9"
	}
}

404 The Bot could not be found at the moment.

{
	"message": [
		"The Bot could not be found at the moment."
	],
	"statusMessage": "failed",
	"status": 0,
	"error": {
		"code": "E1019",
		"key": "BOT_NOT_FOUND",
		"description": "Error to be thrown when trying to get a Bot.",
		"developerMessages": {
			"es": "El botId no se encuentra en la base de datos o ha sido eliminado.",
			"en": "The botId is not found in the database or has been deleted.",
			"pt": "A botId não é encontrada no banco de dados ou foi apagada."
		},
		"clientMessages": {
			"es": "El Bot no se pudo encontrar por el momento.",
			"en": "The Bot could not be found at the moment.",
			"pt": "A Bot não pôde ser encontrada no momento."
		}
	}
}

500: Internal Server Error We are having trouble processing your request.

{
  "message": [
    "We are having trouble processing your request. Please try again later."
  ],
  "statusMessage": "failed",
  "status": 0,
  "error": {
    "code": "E0000",
    "key": "UNKNOWN_ERROR",
    "description": "Error to be thrown when it couldn't be determined the reason of failure",
    "developerMessages": {
      "es": "Error inesperado occurido, revisar logs.",
      "en": "Unexpected error occurred, check logs."
    },
    "clientMessages": {
      "es": "Estamos teniendo problemas procesando la solicitud. Por favor intenta mas tarde.",
      "en": "We are having trouble processing your request. Please try again later."
    }
  }
}

Subscribe to Events

POST https://api.jelou.ai/v1/bots/:botId/events/webhook

This endpoint allows you to subscribe to your webhook

Path Parameters

Name	Type	Description
botId*	string	ID of the Bot.

Query Parameters

Name	Type	Description
url*	string	Webhook URL
events*	array	events to subscribe
webhooks*	string	General parameter

200 Webhooks created successfully!

{
  "message": [
    "Webhooks created successfully!"
  ],
  "statusMessage": "success",
  "status": 1,
  "data": [
    {
      "url": "https://webhook.site/379dd1bd-a753-499d-b9dd-23979020bcd9",
      "events": [
        "delivered_user",
        "delivered_channel"
      ]
    },
    {
      "url": "https://webhook.site/441c4bc1-5d11-4314-b89b-37fb5b3d16f5",
      "events": [
        "failed",
        "reply"
      ]
    }
  ]
}

404: Not Found The Bot could not be found at the moment.

{
	"message": [
		"The Bot could not be found at the moment."
	],
	"statusMessage": "failed",
	"status": 0,
	"error": {
		"code": "E1019",
		"key": "BOT_NOT_FOUND",
		"description": "Error to be thrown when trying to get a Bot.",
		"developerMessages": {
			"es": "El botId no se encuentra en la base de datos o ha sido eliminado.",
			"en": "The botId is not found in the database or has been deleted.",
			"pt": "A botId não é encontrada no banco de dados ou foi apagada."
		},
		"clientMessages": {
			"es": "El Bot no se pudo encontrar por el momento.",
			"en": "The Bot could not be found at the moment.",
			"pt": "A Bot não pôde ser encontrada no momento."
		}
	}
}

500: Internal Server Error We are having trouble processing your request.

{
  "message": [
    "We are having trouble processing your request. Please try again later."
  ],
  "statusMessage": "failed",
  "status": 0,
  "error": {
    "code": "E0000",
    "key": "UNKNOWN_ERROR",
    "description": "Error to be thrown when it couldn't be determined the reason of failure",
    "developerMessages": {
      "es": "Error inesperado occurido, revisar logs.",
      "en": "Unexpected error occurred, check logs."
    },
    "clientMessages": {
      "es": "Estamos teniendo problemas procesando la solicitud. Por favor intenta mas tarde.",
      "en": "We are having trouble processing your request. Please try again later."
    }
  }
}