Documentation
Set up a manual webhook
Manual webhooks are great for performing one-off actions on members, such as adding a Discord role, sending swag, sending a slack DM, etc. In this doc, weβll walk you through how to set up a manual webhook.
Setting up a Manual Webhook
To get started head to the Settings > Webhooks section of your Workspace. If you havenβt set up any webhooks previously this section will be empty.
Click on New Webhook to start the setup.
Step 1) Give your webhook a name
Every webhook needs a name. The name you choose will appear in the Actions menu throughout the Orbit application so choosing an understandable name is helpful.
For example, if clicking the webhook would ultimately end in a new Person being created in your company Pipedrive account, you could choose the name Create as Person in Pipedrive.
Whatever you choose, try to make it obvious to other users what the outcome of their click is going to be.
Step 2) Choose an Event Subscription
From the dropdown menu, you need to select the type of trigger that will be used. In this case, you are setting up a manually triggered webhook, so select triggered manually from the list.
Step 3) 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.
Step 4) Finalize the setup
To save everything, click on the Create Webhook button.
Using your Manual Webhook
Once set up, all manual webhooks can be found in the Actions menu in the following places:
- On a Member Profile page
- On the Members table when one or more members are selected
To use them, click on the Actions menu to reveal all the options:
Any manual webhooks you have set up will be at the bottom of the list under the Webhooks section.
Click on any webhook to trigger it. To prevent accidental clicks from sending data erroneously to other systems, a modal will appear that will show you:
- The name of the Member you are sending
- The name of the webhook action you are using
- The URL of the webhook that will receive the data
If everything looks good, click Confirm and the data payload will be sent.
Checking the Status of your Webhooks
At any time, there are four places you can check to see the status of your webhook deliveries.
Actions Tab
The first is the Actions tab on a member profile page. Here you will see any and all of the actions performed by you, and other users of your workspace.
Webhook deliveries are identified like this:
You can see the user who triggered the action, what action it was, the time and date and whether or not it was successful.
Actions Log
The second place you can check on webhook deliveries is in Settings > Actions Log. There you will see a list of all the actions performed by any users of your workspace along with their success or failure details.
Webhook Deliveries
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.
Your Inbox
We will also send an email to the address associated with your Orbit account that will inform you of the success or failure of any of your webhook triggers.
How would I trigger a webhook automatically?
If you find you want to convert a manual webhook to an automatic one, follow the steps in this doc:
- Set up a manual webhook
- Setting up a Manual Webhook
- Step 1) Give your webhook a name
- Step 2) Choose an Event Subscription
- Step 3) Set your Webhook URL
- Step 4) Finalize the setup
- Using your Manual Webhook
- Checking the Status of your Webhooks
- Actions Tab
- Actions Log
- Webhook Deliveries
- Your Inbox
- How would I trigger a webhook automatically?