Skip to main content

Types of Events

Webhook Event types consist of a scope, locality, and event. The are formatted into a single string defining the Webhook Event.

Event Format:​

#{scope}:#{locality}:#{event}

Example Event:​

public:direct:donation_updated

Scope​

Scope describes the level of visibility of the data sent in the Webhook Payload.

  • public - Always available. This will return publicly available data in the Webhook Payload.

  • private - Only available in the Developer Dashboard. This will return all of the publically available data as well as some sensitive data for donations, like the donor_email and the answer to a reward custom_question.

Locality​

This describes the source of the event. Because the various Facts in our system can support eachother, the locality lets you choose between events that happen directly to the Fact, or to one of its children.

  • direct - Describes events that directly occur to the subscribed Fact.

  • indirect - Describes events that occur to the subscribed Fact's children. For example, the various Campaigns supporting a Team Campaign, or all of the Facts supporting a Fundraising Event

Event​

This describes the specific event that is going to be sent to your Webhook Endpoint.

  • donation_updated - Describes when a Donation is updated. This will combine new donations, as well as donations being moderated and refunded.

  • fact_updated - Describes when a Fact is updated. Whether that includes the various details of the Fact, or the amount_raised by all of the Donations toward that Fact.

List of Events​

This is a complete list of the supported events for Webhook Subscriptions.

  • private:direct:donation_updated
  • private:direct:fact_updated
  • private:indirect:donation_updated
  • private:indirect:fact_updated
  • public:direct:donation_updated
  • public:direct:fact_updated
  • public:indirect:donation_updated
  • public:indirect:fact_updated