The Webhook page allows you to register for commands to be triggered from an external web service. Currently, each user can have up to 5 webhooks. Once a webhook is created, the user can add the command as desired. These commands can expect to take in JSON parameters and the JSON icon can be used to map JSON to special identifiers, similar to how the Web Request Action works.
Ko-fi, Fourthwall, and Throne now have dedicated integrations on the Services page that provide their own events and special identifiers, so a manual webhook is no longer required for them. See the Ko-fi, Fourthwall, and Throne service pages for details. Manual webhooks remain available for any other service.
If you are having issues with a particular webhook, please come to our Discord and ask for help. Each implementation of webhooks is different and it may require special assistance.
Related Special Identifier:
- $webhookpayload = The complete payload sent from the webhook. This is mostly for debugging and isn’t expected to be used most of the time. Instead, the JSON to Special Identifier mapping should be used.
Steps to use Webhooks
-
Open the webhooks page.
-
Click the “Add Webhook” button.
-
Click the “Add Command” button and create your action as desired.
-
If necessary, map JSON and add actions.
-
Save the command and use the “Copy URL” button to grab the trigger for the webhook.
BE WARNED: ANYONE THAT GETS ACCESS TO THIS URL COULD TRIGGER THE ACTION! Only share this URL with trusted sources. The URL is in the form of: https://desktop.api.mixitup.bot/api/webhook/{SomeId}?secret={SomeSecret}
- Go to the external website, such as Ko-fi, and enter the necessary information.
At this point, you should be able to test the webhook and the event should trigger!