Webhooks are a way to send a message to a server (usually a web server) or service (e.g. Microsoft Teams). They are a way for systems to communicate using HTTP URL's (like you can send an SMS to a phone number).
|
We do not provide technical support for using webhooks. Unfortunately we frequently receive requests for help using webhooks where the issue is that the webhook has not been configured correctly or the user does not understand how the webhook works.
Please contact the provider of the webhook service for help and not 2BrightSparks.
It is important to note that if you send a message, e.g. JSON, then the webhook call will be a HTTP POST. If there is no message then the webhook call will be a HTTP GET. |
•Send a webhook message if the profile run fails: If enabled, then when the profile run files, the specified webhook will be called if the profile fails.
oWebhook URL: This is the URL that is called. It can contain variables. For the URL, you must consult the server or service you are using.
oMessage: This is the (optional) message that is sent to the webhook URL. It can contain variables. The message content may need to be in a specific format (e.g. JSON) or may not be required (consult the server or service you are using). If you send a message, e.g. JSON, then the webhook call will be a HTTP POST. If there is no message then the webhook call will be a HTTP GET.
•Send a webhook message if the profile run is a success: If enabled, then when the profile run files, the specified webhook will be called if the profile does not fail.
oWebhook URL: This is the URL that is called. It can contain variables. For the URL, you must consult the server or service you are using.
oMessage: This is the (optional) message that is sent to the webhook URL. It can contain variables. The message content may need to be in a specific format (e.g. JSON) or may not be required (consult the server or service you are using). If you send a message, e.g. JSON, then the webhook call will be a HTTP POST. If there is no message then the webhook call will be a HTTP GET.
Also, it is important that you refer to the documentation (and technical support) for the webhook service you are using. Also, there are free sites available to test your webhooks.
All Content: 2BrightSparks Pte Ltd © 2003-2024