6.2.Current Events
6.3. Logs
1. What are Webhooks?
❗️This feature requires technical implementation. If you need to create an integration, we recommend sending this article to the person who manages your System or (IT).
Webhooks are events that trigger actions. They allow different programs on the Internet to send information to each other in real-time.
Webhooks are triggered when a specific event takes place hence they are also commonly known as Events.
This is the easiest way of receiving a notification when something relevant happens in within two different systems, from your Stockcrowd Account environment to a CRM.
2. Webhooks in Stockcrowd
❗️The type of coding for any event is UTF-8.
Each time an event occurs, we can send information to your Organisation in one of two ways:
Send a notification to your Email,
Post them to a URL defined by you.
The data that we send depends on the type of event that occurred.
To set up an event, you must:
Select the type of event to be set.
Set up the Notification method (Email or URL).
Activate the Event.
Once the Webhook is set, Stockcrowd will send notifications every time this event is triggered, posting the relevant data in the URL or email.
3. Event Types in Stockcrowd
Stockcrowd has the following Event types available:
Event type | Description |
|
INVERSOR_CREATED | User registration completed |
|
INVERSOR_PAYMENT_CREATED | A payment request has been created |
|
INVERSOR_PAYMENT_SUCCEEDED | Payment request confirmed |
|
RECOMPENSA_SOLD | Data of a reward associated with a successful payment |
|
BLACKBAUD_TOKENIZATION | Fundraising using BLACKBAUD in tokenization mode |
|
SIGNATURE_CREATED | Signature collection record associated with a campaign |
|
CAMPAIGN_ACTIVATED | Campaign Activation |
|
INVERSOR_PAYMENT_REFUND | Return of the confirmed request |
|
INVERSOR_PAYMENT_SUBSCRIPTION_CANCELLED | Recurring Charge Subscription Cancellation |
|
INVERSOR_PAYMENT_SUBSCRIPTION_CHANGED | Recurring Charge Subscription Changes |
|
RECURRING_CHARGE_CREATED | Recurring charge created |
|
INVERSOR_PAYMENT_SUBSCRIPTION_FAILED | Failed payment on recurring subscription charge |
|
P2P_CAMPAIGN_CREATED | Campaign challenge created |
|
P2P_CAMPAIGN_UPDATED | Updated campaign challenge |
|
P2P_CAMPAIGN_APPROVED | Campaign challenge approved |
|
INVERSOR_PAYMENT_ABANDONED | Abandoned payment |
|
👉 For more information on how to set the events, please check the Company (Organization) > Notifications section of your Account, and select the Event Type you wish to set up.
4. How to set up a Webhook
You can set up Webhooks from Organisation > Notifications;
You will see the list of events available in this section.
Select the type of Event for which you want to receive information to see more details and to open more options in settings:
1. Clicking on the Event Fields icon
Upon opening more options, you will see a section detailing the data you will receive for each event and in which format.
If you have added Custom Fields to your campaigns, then these will also be added to your Events.
5. Set up the notification via URL or email
1. Select the Event you want to set up.
2. Select the icon in the Subscribers column.
A pop-up window will open to view information on already created subscriptions if you have them, and you'll also see an 'add' button for a new one."
Once you have clicked on 'add', you will see the next screen where you can choose from the following options:
Receive notifications for all Campaigns or just a specific one, and
Where you want to send the data (Email or URL)
Activate the subscription when it is ready
Skip sending events when they are offline contributions. Click here to learn more about offline contributions.
Skip sending events when it is a CRM transaction. Click here to learn more about CRM transactions.
It will send events from operations carried out in the campaign before creating the subscription."
In the case of a URL, your IT team will need to set up the URL to which you wish for us to post the information. They can also choose to enable an API key for authentication and select the format.
Apart from configuring this in Stockcrowd, your IT team will also need to make the configurations in your CRM Software where you want to receive the information via URL.
👉 We recommend following the Fields > Event Validation section instructions to configure and test the Webhook.
6. Manage your Webhooks
6.1. Registered Subscriptions
Once you have set up a Webhook, You can see Registered Subscriptions in Subscribers..
In this section, you can view and manage all the Webhooks you have configured for this particular event.
If you need to make changes to a defined Webhook, select the icon in the Options column:
6. Current Events
Find all your sent Webhooks by accessing the event from its name or through the eye icon:
You can check the dispatches there and even resend a message if interested.
To resend a message, click on the aeroplane icon.
6.3. Event History (Logs)
Please look over the history of an event. Once you have accessed the sent messages, you can see the available options in the gear icon.
Data - Information sent in the event
HTTP logs - Logs from when the information is sent to a URL
Errors - Error messages when the event has not been sent. In case of a failure in the event delivery, the system will retry sending every 24 hours for a total of three attempts.
