Webhooks
Cases

Cases

🚧

As the service is in beta, the body of the webhook may change in the future. We will try to keep the changes to a minimum, but we cannot guarantee that the body will stay the same.

Create

Invocation Body

{
  webhookEvent: "case:create";
  payload: {
    id: string;
    createdAt: Date;
    createdBy: string;
    updatedAt: Date;
    updatedBy: string;
    displayId: number;
    name: string;
    preconditions: string;
    steps: {
      action: string;
      expectation: string;
    }[];
    customFields: { [key: string]: any };
  };
}

Update

Invocation Body

{
  webhookEvent: "case:update";
  payload: {
    id: string;
    createdAt: Date;
    createdBy: string;
    updatedAt: Date;
    updatedBy: string;
    displayId: number;
    name: string;
    preconditions: string;
    steps: {
      action: string;
      expectation: string;
    }[];
    customFields: { [key: string]: any };
  };
}

Delete

Invocation Body

{
  webhookEvent: "case:delete";
  payload: {
    id: string;
    createdAt: Date;
    createdBy: string;
    updatedAt: Date;
    updatedBy: string;
    displayId: number;
    name: string;
    preconditions: string;
    steps: {
      action: string;
      expectation: string;
    }[];
    customFields: { [key: string]: any };
  };
}
WebhooksMilestones