Webhook Events - Campaign

Vouch Webhooks enable callbacks to be made to Enterprise customer's HTTP(S) endpoints when specific events have been triggered (often referred to as notifications).

The following document outlines the expected payload for these Webhooks relating to the Campaign function within the Platform.

campaign.created

Event is generated whenever a new Campaign is created via the REST API or Admin User Interface.

"event" : {
  "name" : "campaign.created",
  "timestamp" : "2021-07-06T10:08:08.683Z",
  "campaign" : {
    "id" : "cccccccccc",
    "name" : "Happy Customers",
    "status" : "DRAFT"
  },
  "entity" : {
    "id" : "eeeeeeeeee",
    "name" : "Vouch",
    "url" : "https://vouchfor.com"
  },
  "account" : {
    "name" : "Account Contact",
    "email" : "[email protected]"
  }
}

campaign.deleted

Event is generated whenever a Campaign is deleted via the REST API or Admin User Interface.

"event" : {
  "name" : "campaign.deleted",
  "timestamp" : "2021-07-06T10:08:08.683Z",
  "campaign" : {
    "id" : "cccccccccc",
    "name" : "Happy Customers",
    "status" : "DRAFT | LIVE"
  },
  "entity" : {
    "id" : "eeeeeeeeee",
    "name" : "Vouch",
    "url" : "https://vouchfor.com"
  },
  "account" : {
    "name" : "Account Contact",
    "email" : "[email protected]uchfor.com"
  }
}

campaign.published

Event is generated whenever a Campaign is set to published via the REST API or Admin User Interface.

Note: A Campaign is automatically set as published when created via the REST API.

"event" : {
  "name" : "campaign.published",
  "timestamp" : "2021-07-06T10:08:08.683Z",
  "campaign" : {
    "id" : "cccccccccc",
    "name" : "Happy Customers",
    "status" : "LIVE",
    "url" : "https://app.vouchfor.com/c/cccccccccc"
  },
  "entity" : {
    "id" : "eeeeeeeeee",
    "name" : "Vouch",
    "url" : "https://vouchfor.com"
  },
  "account" : {
    "name" : "Account Contact",
    "email" : "[email protected]"
  }
}

campaign.paused

Event is generated whenever a Campaign is paused via the REST API or Admin User Interface.

"event" : {
  "name" : "campaign.paused",
  "timestamp" : "2021-07-06T10:08:08.683Z",
  "campaign" : {
    "id" : "cccccccccc",
    "name" : "Happy Customers",
    "status" : "PAUSED"
  },
  "entity" : {
    "id" : "eeeeeeeeee",
    "name" : "Vouch",
    "url" : "https://vouchfor.com"
  },
  "account" : {
    "name" : "Account Contact",
    "email" : "[email protected]"
  }
}

campaign.viewed

Event is generated whenever a published Campaign is viewed by the responder.

"event" : {
  "name" : "campaign.viewed",
  "timestamp" : "2021-07-06T10:08:08.683Z",
  "campaign" : {
    "id" : "cccccccccc",
    "name" : "Happy Customers",
    "status" : "LIVE",
    "url" : "https://app.vouchfor.com/c/cccccccccc",
    "counts" : {
      "views" : 1,
      "starts" : 0,
      "responses" : 0 
    }
  },
  "entity" : {
    "id" : "eeeeeeeeee",
    "name" : "Vouch",
    "url" : "https://vouchfor.com"
  },
  "account" : {
    "name" : "Account Contact",
    "email" : "[email protected]"
  }
}

campaign.started

Event is generated whenever a published Campaign is started by a responder.

Note: A vouch.created webhook will also be generated at the same time.

"event" : {
  "name" : "campaign.started",
  "timestamp" : "2021-07-06T10:08:08.683Z",
  "campaign" : {
    "id" : "cccccccccc",
    "name" : "Happy Customers",
    "status" : "LIVE",
    "url" : "https://app.vouchfor.com/c/cccccccccc",
    "counts" : {
      "views" : 1,
      "starts" : 1,
      "responses" : 0 
    }
  },
  "entity" : {
    "id" : "eeeeeeeeee",
    "name" : "Vouch",
    "url" : "https://vouchfor.com"
  },
  "account" : {
    "name" : "Account Contact",
    "email" : "[email protected]"
  },
  "vouch" : {
    "id" : "vvvvvvvvvv",
    "status" : "VIEWED",
    "url" : "https://app.vouchfor.com/request/vvvvvvvvvv"
  },
  "customer" : {
    "name" : "Vouch",
    "url" : "https://vouchfor.com"
  },
  "contact" : {
    "name" : "Responder",
    "email" : "[email protected]"
  }
}

campaign.responded

Event is generated whenever a responder submits a completed Campaign.

Note: A vouch.submitted webhook will also be generated at the same time.

"event" : {
  "name" : "campaign.responded",
  "timestamp" : "2021-07-06T10:08:08.683Z",
  "campaign" : {
    "id" : "cccccccccc",
    "name" : "Happy Customers",
    "status" : "LIVE",
    "url" : "https://app.vouchfor.com/c/cccccccccc",
    "counts" : {
      "views" : 1,
      "starts" : 1,
      "responses" : 1 
    }
  },
  "entity" : {
    "id" : "eeeeeeeeee",
    "name" : "Vouch",
    "url" : "https://vouchfor.com"
  },
  "account" : {
    "name" : "Account Contact",
    "email" : "[email protected]"
  },
  "vouch" : {
    "id" : "vvvvvvvvvv",
    "status" : "RESPONDED",
    "url" : "https://app.vouchfor.com/vvvvvvvvvv"
  },
  "customer" : {
    "name" : "Vouch",
    "url" : "https://vouchfor.com"
  },
  "contact" : {
    "name" : "Responder",
    "email" : "[email protected]"
  }
}