Documentation
Set up an automated webhook
In some cases, you may want a webhook to occur automatically on a member in your community (ex. they reach an activity milestone and should be sent swag, they became inactive and should be sent a check-in DM)
Check out this video to learn how, or follow the written steps below.
Step 1) Set up a manual webhook
We recommend setting up a manual webhook first. This will allow you to use this webhook manually first, which is great for testing out how it works and getting a better gauge on what criteria you want to use to trigger the webhook automatically in the future.
To set up a manual webhook, follow the instructions here:
Step 2) Create an automated webhook workflow
After you’ve determined who you want to automatically send to a webhook, we can create a workflow that will send members to your webhook automatically. To do so, do the following:
- Go to Workflows tab and click Send Webhook
- Select the criteria that needs to match in order for a member to be sent to the webhook
- Select the webhook you want to send from the dropdown
- Click Run Workflow. Now each day, Orbit will check for members that match your criteria and will send matching members to your webhook.
Want to check on your past workflow runs? Go to Workflows, click on your workflow, and you can see all the past runs in your workflow log.
Send a webhook based on a different trigger
If you want to send a webhook based on another trigger (i.e. when an activity occurs, when a new member is added to your community, etc), you can do so using the Webhooks tab. Go to Settings → Webhooks to find it.
Note: this way of automatically sending webhooks is the old way to do it, so the filtering criteria is less flexible than that of Workflows.
Step 1) Give your webhook a name
The name you choose will help your team more easily identify your automated webhook in the future.
For example, if the webhook automatically adds new members to your company’s CRM, you could choose the name Auto-add New Member to CRM.
Choose an Event Subscription
From the dropdown menu, you need to select the type of trigger that will be used. Since you are setting up an automated webhook, you should select one of the automatic triggers.
Set your Webhook URL
The final step in the setup is to define the webhook URL that will receive the member profile payload data when the action is triggered. If you are connecting to a low/no code solution like Zapier, Make, Pipedream or n8n, they will provide this for you.
If you are connecting to your own application, or a serverless script running on a service such as AWS Lambda, you will need the full URL endpoint that is set up to receive the data Orbit will be sending.
You can find out more about the specifics of the payload, the requests that Orbit sends and how to use the Webhook Secret in our Webhooks documentation.
Finalize the setup
To save everything, click on the Create Webhook button. And that’s it! Now your webhook should automatically run when the trigger you choose occurs.
Checking the Status of your Webhooks
If you created your automated webhooks via Workflows, you can check the status by going to Workflows, clicking on your Workflow that you created, and seeing a log of past runs.
Otherwise, you can check for webhook deliveries on the settings page for the webhook itself. You access these through Settings > Webhooks by clicking on the name of any of the webhooks you have set up.
Each page has a Recent Deliveries section that shows you when a delivery took place, and if it was successful.
