Engine Webhooks

General

The Engine Webhooks tab in the User Account or Team Account Settings of a PolySwarm UI Account allows you to manage engine webhooks used by your Account. In a Team Account, a User must have the Team Admin or Microengine Admin role to view and use the Engine Webhooks tab.

HMAC Secret

The engine webhook's HMAC Secret is used to allow the remote web service to verify that the engine webhook call was made by the PolySwarm Marketplace. All engine webhook calls are signed using the HMAC Secret, and can thus be verified by the recipient. In the Engine Webhooks tab, the HMAC Secret is hidden by default. You can click the "Eye" icon to view it or click the "Copy" icon to copy it to your clipboard.

Rate Limit

The rate limit is the number of engine webhook messages your engine webhook URL can process in one day (24hr period). This is the mechanism that you can use to control how many bounties your Engine receives in a day.

Status

An engine webhook's Status will be in one of the following states:

• Pending - The engine webhook has been created, but has not been tested.
• Verified - The engine webhook has been tested and the remote service responded correctly.
• Failed - The engine webhook was Verified, but the remote service is no longer responding. If an engine webhook is in the Failed state, it needs to be Tested again to become Verified.

URL

The engine webhook URL must be the full URI that your web server is listening on to receive an engine webhook. It must use HTTPS. Often it will be something like: "https://example.com:1234/my/api/"

Creating

To create your first engine webhook, click the "Create webhook" button to open the engine webhook creation window. If you have one or more existing engine webhooks, you can click the "+" button to create another one.

In the Create Engine Webhook window, enter the engine webhook URL and its Rate Limit. Then click Save.

Deleting

To delete an engine webhook, click the "Trash" icon in the Actions column.

An engine webhook cannot be deleted if it is associated with an Engine. You need to remove the engine webhook association from the Engine, and then you can delete the engine webhook.

Testing

In the Actions column, you can click on the "Gear" icon to open the Engine Webhook Test window. Click the "Test" button to send a "Ping" action to the remote engine webhook server. Give it about one minute to send the engine webhook. If the engine webhook server responds to the Ping action, the Status will update to be "verified".