Configuring a webhook
Webhooks are available for adding participants and creating events. Available post method configurations include HTTP, AWS SQS, and Azure Event Hubs.
You can manage webhooks from CSRconnect Admin Portal, Community setup, Integrations, Webhooks.
You must have the Can Access Webhooks and Can Manage Webhooks permissions. See Manage roles.
Create a webhook
-
Navigate to CSRconnect Admin Portal, Community setup, Integrations, Webhooks.
-
Select New Webhook.
-
Enter a name for the webhook.
-
Select Functionality, Volunteer.
-
In the Subscribe to Message drop-down field, select the message type to subscribe to.
-
In the Method drop-down field, select the post method to use for this webhook.
-
Complete any other required or applicable fields.
-
Select Save.
Edit a webhook
-
Navigate to CSRconnect Admin Portal, Community setup, Integrations, Webhooks.
-
Review the list to locate the webhook. If it is currently running, select Stop.
-
Select Editfor the listing.
-
Include any adjustments.
-
Select Save.
Remove a webhook
-
Navigate to CSRconnect Admin Portal, Community setup, Integrations, Webhooks.
-
Review the list to locate the webhook. If it is currently running, select Stop.
-
Select Remove.
-
To confirm removing the webhook you selected from the list, select Remove on the confirmation message.
Sample webhook message: Participant was added
{
"eventId":912,
"eventType":1,
"reccurrenceId":5,
"occurrenceId":2,
"shiftId":3114,
"hours":2.0,
"charityId":null,
"affiliateOrganizationId":null,
"organizationName":"hhhh",
"affiliateEmployeeId":2483669,
"employeeFirstName":"test",
"employeeLastName":"support",
"participationDate":"2019-07-18T00:00:00Z",
"createdDate":"2019-07-12T15:13:52.6269356+00:00",
"affiliateId":0,
"existingParticipation":false,
"active":true,
"guestId":null
}
Sample webhook message: Event was created
{
"eventId": 0,
"name": "Test5",
"startDateUtc": "2019-07-22T06:00:00",
"endDateUtc": "2019-08-10T06:00:00",
"charityId": 4575269,
"affiliateOrganizationId": null,
"organizationName": "A LITTLE BIT OF LOVE",
"eventType": 1,
"affiliateId": 0
}