Skip to main content

Webhook Plugin

The Webhook plugin allows integration between external applications and 1Gateway by processing incoming webhook messages and converting them into structured messages.

Webhook Endpoint Configuration​

For external products to send messages to 1Gateway, they must configure a rule that directs messages to the following URL:

https://<1gateway_instance>/api/v4/message/send?webhook=<plugin_name>

This URL can also include extra parameters for additional processing.

  • Use http method POST

  • Body can be any JSON string

  • Authentication: Authentication depends on the authentication mechansim used in your 1Gateway installation. In case of basic authentication, use basic Authentcation with username and password. In case of OAuth, use necessary OAuth configuration.

note

1Gateway can be configured to allow an unauthentcated URL: https://<1gateway-instance>/ap/v4/message/sendNoAuth?webhook=<plugin-name>. In this case, use an HTTP POST to the URL with no Authentication.

Configuration​

FieldOptionsDescription
Message typeAny stringSyslog listen port
Product nameAny stringThe external product sending the message
ID locationMessage fieldLocation of the ID field in the incoming message
Next Hop TypePlugin/OtherSpecifies the type of next step in the workflow for the generated message
Next Hop NameAny stringName of the next component where the message will be sent after being published

Example​

Using the format mentinoned above https://<1gateway-instance>/ap/v4/message/sendNoAuth?webhook=<plugin-name> we can fill in the necessary values.

  • <1gateway-instance> = blizzard.test.1bonding.com
  • <plugin-name> = Webhook%20blizzard%20servicenow

The full URL is:

https://blizzard.test.1bonding.com/api/v4/message/send?webhook=Webhook%20blizzard%20servicenow

Webhook message

Webhook Message Fields

Headers​

  • Product: The external product sending the message

  • ID Location: The path or identifier field for the message

  • Message type defined in the plugin

Message Body​

  • Includes all request parameters set in the webhook configuration.

Webhook message