Skip to main content

What Initiative data can I receive when I subscribe to a Virtuous Volunteer Webhook?

Molly Kinder
  • Updated
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 Campaign Webhooks.

Note that there are two types of Webhooks you can subscribe to here (Campaigns for your Org Only, or Public Campaigns from other orgs on the Virtuous Volunteer Network). Subscribe to Your Campaigns only if you just want your organization's Campaign data sent to you.

Campaign Created

{
    "type": "campaign.created",
    "organization_id": 1,
    "data": {
        "type": "campaign",
        "id": "10000",
        "campaign_name": "Test Campaign",
        "description": null,
        "url": "http://www.vomo.test/campaign/test-campaign-asdfasf",
        "organization": "Virtuous Volunteer",
        "organization_slug": "vomo",
        "organization_id": 1,
        "author_id": 12345,
        "logo_url": "https://s3.amazonaws.com/awakenmycity/j2/7Z/r4-s.jpg",
        "created_at": "2021-03-29T20:49:09+00:00",
        "updated_at": "2021-03-29T20:49:09+00:00"
    }
}

Campaign Updated

{
    "type": "campaign.updated",
    "organization_id": 1,
    "data": {
        "type": "campaign",
        "id": "10000",
        "campaign_name": "Test Campaign",
        "description": null,
        "url": "http://www.vomo.test/campaign/test-campaign-asdfasf",
        "organization": "Virtuous Volunteer",
        "organization_slug": "vomo",
        "organization_id": 1,
        "author_id": 12345,
        "logo_url": "https://s3.amazonaws.com/awakenmycity/j2/7Z/r4-s.jpg",
        "created_at": "2021-03-29T20:49:09+00:00",
        "updated_at": "2021-03-29T20:55:15+00:00"
    }
}

Campaign Deleted

{
    "type": "campaign.deleted",
    "organization_id": 1,
    "data": {
        "type": "campaign",
        "id": "10000",
        "campaign_name": "Test Campaign",
        "description": null,
        "url": "http://www.vomo.test/campaign/test-campaign-asdfasf",
        "organization": "Virtuous Volunteer",
        "organization_slug": "vomo",
        "organization_id": 1,
        "author_id": 12345,
        "logo_url": "https://s3.amazonaws.com/awakenmycity/j2/7Z/r4-s.jpg",
        "created_at": "2021-03-29T20:49:09+00:00",
        "updated_at": "2021-03-29T20:56:18+00:00"
    }
}

Related articles