Note: In a recent product update,
Projects were renamed to Opportunities
Campaigns were renamed to Initiatives.
However, the code for the Virtuous Volunteer API/Webhooks
will continue to use the terms
Projects and Campaigns.
Below is a list of the JSON payloads for the Virtuous Volunteer Project Webhooks.
Note that there are two types of Webhooks you can subscribe to here (Projects for your Org Only, or Public Projects from other orgs on the Virtuous Volunteer Network). Subscribe to Your Projects only if you just want your organization's project data sent to you.
Project Created
{
"type": "project.created",
"organization_id": 1,
"data": {
"type": "project",
"id": "90909",
"project_name": "Website Maintenance",
"description": "This role keeps our website up to date with the latest & greatest, from uploading media files and resources, to updating existing content.",
"url": "http://www.vomo.test/project/website-maintenance-webhooks",
"organization_id": 1,
"organization": "Virtuous Volunteer",
"organization_slug": "vomo",
"author_id": null,
"owners": [{
"id": 12345,
"project_id": 90909,
"user_id": 121212,
"is_primary_owner": 1,
"send_notifications": 1,
"created_at": "2021-03-29 21:25:37",
"updated_at": "2021-03-29 21:25:37"
}],
"address": {
"lat": 33.0059709,
"lng": -96.7064243,
"route": "North Central Expressway",
"venue": null,
"country": "United States",
"locality": "Plano",
"timezone": "America/Chicago",
"postal_code": "75074",
"route_short": "N Central Expy",
"country_short": "US",
"street_number": "500",
"locality_short": "Plano",
"formatted_address": "500 N Central Expy, Plano, TX 75074, USA",
"postal_code_short": "75074",
"street_number_short": "500",
"administrative_area_level_1": "Texas",
"administrative_area_level_1_short": "TX"
},
"anytime": 0,
"created_at": "2021-03-29T21:25:37+00:00",
"updated_at": "2021-03-29T21:25:37+00:00",
"published_at": "2021-03-29T21:25:37+00:00",
"draft": false,
"campaigns": [],
"form_completions": [],
"next_date": {
"type": "project_date",
"id": 545454,
"starts_at": "2021-03-31T14:00:00+00:00",
"ends_at": "2021-03-31T17:00:00+00:00",
"participant_count": 0
},
"images": [
"https://vomo-core-test.s3.amazonaws.com/media/2021/03/121212-vh1r16le-l.jpg"
],
"all_dates": [{
"type": "project_date",
"id": 545454,
"starts_at": "2021-03-31T14:00:00+00:00",
"ends_at": "2021-03-31T17:00:00+00:00",
"participant_count": 0
}],
"point_person": {
"name": null,
"phone": null,
"email": null
},
"allow_guests": true,
"age_limit": 13,
"volunteer_question": null,
"participant_approval_required": false,
"background_check_required": 0,
"show_volunteer_counter": 1,
"volunteer_counter_threshold": 10,
"privacy": "PRIVATE"
}
}
Project Updated
{
"type": "project.updated",
"organization_id": 1,
"data": {
"type": "project",
"id": "90909",
"project_name": "Website Maintenance",
"description": "This role keeps our website up to date with the latest & greatest, from uploading media files and resources, to updating existing content.",
"url": "http://www.vomo.test/project/website-maintenance-webhooks",
"organization_id": 1,
"organization": "Virtuous Volunteer",
"organization_slug": "vomo",
"author_id": null,
"owners": [{
"id": 12345,
"project_id": 90909,
"user_id": 121212,
"is_primary_owner": 1,
"send_notifications": 1,
"created_at": "2021-03-29 21:25:37",
"updated_at": "2021-03-29 21:25:37"
}],
"address": {
"lat": 33.0059709,
"lng": -96.7064243,
"route": "North Central Expressway",
"venue": null,
"country": "United States",
"locality": "Plano",
"timezone": "America/Chicago",
"postal_code": "75074",
"route_short": "N Central Expy",
"country_short": "US",
"street_number": "500",
"locality_short": "Plano",
"formatted_address": "500 N Central Expy, Plano, TX 75074, USA",
"postal_code_short": "75074",
"street_number_short": "500",
"administrative_area_level_1": "Texas",
"administrative_area_level_1_short": "TX"
},
"anytime": 0,
"created_at": "2021-03-29T21:25:37+00:00",
"updated_at": "2021-03-29T21:31:58+00:00",
"published_at": "2021-03-29T21:25:37+00:00",
"draft": false,
"campaigns": [],
"form_completions": [],
"next_date": {
"type": "project_date",
"id": 545454,
"starts_at": "2021-03-31T14:00:00+00:00",
"ends_at": "2021-03-31T17:00:00+00:00",
"participant_count": 0
},
"images": [
"https://vomo-core-test.s3.amazonaws.com/media/2021/03/121212-vh1r16le-l.jpg"
],
"all_dates": [{
"type": "project_date",
"id": 545454,
"starts_at": "2021-03-31T14:00:00+00:00",
"ends_at": "2021-03-31T17:00:00+00:00",
"participant_count": 0
}],
"point_person": {
"name": null,
"phone": null,
"email": null
},
"allow_guests": true,
"age_limit": 13,
"volunteer_question": null,
"participant_approval_required": false,
"background_check_required": 0,
"show_volunteer_counter": 1,
"volunteer_counter_threshold": 10,
"privacy": "PRIVATE"
}
}
Project Deleted
{
"type": "project.deleted",
"organization_id": 1,
"data": {
"type": "project",
"id": "90909",
"project_name": "Website Maintenance",
"description": "This role keeps our website up to date with the latest & greatest, from uploading media files and resources, to updating existing content.",
"url": "http://www.vomo.test/project/website-maintenance-webhooks",
"organization_id": 1,
"organization": "Virtuous Volunteer",
"organization_slug": "vomo",
"author_id": null,
"owners": [{
"id": 12345,
"project_id": 90909,
"user_id": 121212,
"is_primary_owner": 1,
"send_notifications": 1,
"created_at": "2021-03-29 21:25:37",
"updated_at": "2021-03-29 21:25:37"
}],
"address": {
"lat": 33.0059709,
"lng": -96.7064243,
"route": "North Central Expressway",
"venue": null,
"country": "United States",
"locality": "Plano",
"timezone": "America/Chicago",
"postal_code": "75074",
"route_short": "N Central Expy",
"country_short": "US",
"street_number": "500",
"locality_short": "Plano",
"formatted_address": "500 N Central Expy, Plano, TX 75074, USA",
"postal_code_short": "75074",
"street_number_short": "500",
"administrative_area_level_1": "Texas",
"administrative_area_level_1_short": "TX"
},
"anytime": 0,
"created_at": "2021-03-29T21:25:37+00:00",
"updated_at": "2021-03-29T21:31:58+00:00",
"published_at": "2021-03-29T21:25:37+00:00",
"draft": false,
"campaigns": [],
"form_completions": [],
"next_date": {
"type": "project_date",
"id": 545454,
"starts_at": "2021-03-31T14:00:00+00:00",
"ends_at": "2021-03-31T17:00:00+00:00",
"participant_count": 0
},
"images": [
"https://vomo-core-test.s3.amazonaws.com/media/2021/03/121212-vh1r16le-l.jpg"
],
"all_dates": [{
"type": "project_date",
"id": 545454,
"starts_at": "2021-03-31T14:00:00+00:00",
"ends_at": "2021-03-31T17:00:00+00:00",
"participant_count": 0
}],
"point_person": {
"name": null,
"phone": null,
"email": null
},
"allow_guests": true,
"age_limit": 13,
"volunteer_question": null,
"participant_approval_required": false,
"background_check_required": 0,
"show_volunteer_counter": 1,
"volunteer_counter_threshold": 10,
"privacy": "PRIVATE"
}