Flag Planted Webhook

Triggered when a user plants a flag on a question.

To subscribe to this webhook, please set up a URL endpoint capable of receiving POST requests, then let your account manager know the details so we can add it to our system.

Request Details

The request will POST a JSON payload that conforms to the following Typescript interface:

interface FlagPlantedWebhookBody {
  portal: {
    id: string;
  };
  objectId: string;
  planter: {
    id: string;
    name: string;
    email: string;
    customAttributes: Record<string, unknown>;
  };
  comment: string;
  createdAt: string;
  question: {
    objectId: string;
    stem: string;
    url: string;
  };
  test: {
    objectId: string;
    title: string;
  };
}