ActBlue user roles and permissions dictate what users can do on our platform. If the tools or features in this article are unavailable to you, speak to your entity Admin first about updating your permissions.
In this article:
Additional Resources:
- Figuring out which webhook type you will need to use
- Building an integration on top of ActBlue Default webhooks
- For vendors: Requesting a webhook
ActBlue webhooks are a way to connect your ActBlue contribution data to third-party services like a content management system, mailer, or customer relationship management system.
What is a Webhook?
A webhook is a way to notify when an event has occurred. When you receive a contribution through ActBlue, we’ll send this information to the location (endpoint URL) you provide. We can notify you when three events happen: contributions, refunds, and recurring contribution cancellations.
Contribution data is described in the notifications as contributions from donors to entities. They include the donor’s name, address, employer, contribution form used, and other personal information. Read more about the information included in these notifications.
You can request a new webhook in the Integrations tab of your Dashboard. Choose the webhook you need from a dropdown menu depending on what service you want to connect with or whether you’re building a custom integration.
Read our guide on webhook types to understand which one you will need.
We currently offer the following webhooks:
- ActionKit 2.0
- ActionNetwork
- Blue State Digital
- CallTime
- NGP Digital 8
- Numero.ai
- Salesforce
- Salsa
If the service you use isn’t on our list, you can send your vendor our Vendor Form to request a webhook.
Requesting a New Webhook
Step 1: Click the Integrations tab in your Dashboard
In your Dashboard toolbar, click the Integrations tab under “Tools.” If you have set up webhooks before, you’ll see a list of your requested, active, and inactive webhooks.
Step 2: Request a new webhook
Click the “Request a new webhook” button in the top right.
Step 3: Select the webhook type you need from the dropdown menu
After choosing the webhook you need, click “Next.”
Step 4: Enter some basic information
You have the option to include a nickname for your webhook. We recommend you do this to help you differentiate similar webhooks.
Enter the email of your campaign or organization’s main point of contact. We will contact this person about activating your webhook, so make sure the email is accurate.
Step 5: Enter your endpoint and credentials
The endpoint URL and credentials required in this section depend on your webhook type. Check our guide for what specific information you’ll need.
The “Endpoint URL” is where you’d like ActBlue to send your contribution data, and it needs to be a secure URL that begins with “https://”
The “Username” and “Password” fields are the credentials for your endpoint.
Step 6: Optional: Include a “Backfill” date
If you set up a webhook for the first time and have previous donations with ActBlue, you can receive these notifications with our backfill feature.
Select your data’s date range under “Requested backfill start date (optional).” All backfills run from the start date through the webhook activation date.
Step 7: Submit the webhook request
Once you’ve entered the required information, click the “Submit request” button at the bottom. Please note that ActBlue must first approve your webhook request before activating it.
Step 8: The ActBlue team will follow up
After submitting your request, we’ll review it and email the contact you listed once the webhook is active!
Finding and Editing a Webhook
You can always find your webhooks in the Integrations tab of your Dashboard toolbar.
Click the “Edit” button to make changes to a specific webhook.
You can update a webhook’s basic information, like nickname, contact email, and credentials. Click “Save” after making updates.
If you request a backfill of data, you cannot edit the start date you specified for the backfill. Please reach out to your ActBlue contact to request another backfill.
The amount of support that the ActBlue Customer Service Team can provide is dependent on the permissions that you have. Check with your entity Admin about your assigned role.
If you have any questions, please contact our support team using the email address you use to access your ActBlue account.
Comments
0 comments
Article is closed for comments.