From the Webhook subtab of your PhishER Settings, you can create webhooks to connect your PhishER platform to other platforms you use. A webhook, also known as an HTTP push API, is a way for an application to provide another application with real-time information. When messages are triggered by specific PhishER actions, webhooks allow you to send data from the messages to another application.

After you integrate webhooks with your PhishER platform, you can create a PhishER action and select the Send to Webhook option. This option allows PhishER to send the reported messages that are affected by that action to your organization’s webhook. After the action is triggered, you can click a related message in your PhishER Inbox and view which webhook the message is being sent to.

Creating a New Webhook

To connect a new webhook to your PhishER platform, follow the steps below:

1. Log in to your PhishER platform.
2. Navigate to Settings > Webhook.
3. Click the New Webhook button in the top-right corner of the page to open the Add Webhook Settings pop-up window.
4. In the Add Webhook Settings pop-up window that opens, configure your webhook settings. To learn more about these settings, see the screenshot and list below:
   1. Name: In this field, enter a custom name for your webhook.
   2. URL: In this field, enter the URL that you are trying to callback to. For a list of URL rewriters and shorteners that are compatible with PhishER, see our PhishER FAQ article.
   3. Authorization: From the drop-down menu, select one of the following protocols: No Auth, API Key, Bearer Token, or Basic Auth.
   4. Available Data: Select one or more types of data that you would like to send to the webhook.
      Note:The Addresses data type sends all email addresses in the webhook payload, including the email addresses in the From, To, CC, Reply To, and Reported By fields.
   5. Custom Data: To add custom data to your webhook’s payload, click the plus sign icon. Then, fill out the key and value fields. For example, if your application requires "{ "System" : "PhishER" }" in the payload to receive data, you could enter "System" and "PhishER".
   6. Custom Headers: If you would like to add a custom header, click the plus sign icon. Then, fill out the key and value fields. For example, if your firewall requires the "{ "Header" : "PhishER" }” header to allow data to pass through, you could enter "Header" and "PhishER".
   7. Message Tags: In this section, you can select the Success or Failure check boxes if you would like PhishER to assign a tag when the webhook is used to send data. Then, enter a tag name in the field next to the selected check box. 
   
5. Click Create.

Managing Your Webhooks

From the Webhook subtab of your PhishER Settings, you can connect and manage your webhooks. To update a webhook, you can click a webhook’s name to open the Update Webhook Settings pop-up window. Then, you can update the webhook’s information.

For more information about the Webhook subtab, see the screenshot and list below:

1. New Webhook: You can click this button to add a new webhook. For more information about adding a new webhook, see the above subsection of this article.
2. Name: This column displays the name of the webhook.
3. URL: This column displays the URL that the webhook will callback to.
4. Selected Data: This column displays the types of data that you would like to send to the webhook.
5. Success Tag: This column displays the tag that PhishER assigns to a message if the webhook successfully sent data and received a callback URL.
6. Failure Tag: This column displays the tag that PhishER assigns to a message if the webhook was unable to send data and receive a callback URL.
7. Actions: This column displays the actions available to run on a webhook entry. You can click the trash can icon to delete the entry.