Skip to content

Variable: WebhookPayload ​

ts
const WebhookPayload: z.ZodObject<{
  data: z.ZodRecord<z.ZodString, z.ZodUnknown>;
  id: z.ZodString;
  occurredAt: z.ZodCoercedDate<unknown>;
  resource: z.ZodObject<{
     id: z.ZodString;
     type: z.ZodString;
  }, z.core.$strip>;
  tenantId: z.ZodGUID;
  type: z.ZodUnion<readonly [z.ZodEnum<{
     app.circuit.opened: "app.circuit.opened";
     approval.decided: "approval.decided";
     approval.requested: "approval.requested";
     case.assigned: "case.assigned";
     case.closed: "case.closed";
     case.created: "case.created";
     case.decided: "case.decided";
     case.sla.breached: "case.sla.breached";
     decision.created: "decision.created";
     run.completed: "run.completed";
     run.failed: "run.failed";
     submission.link_requested: "submission.link_requested";
  }>, z.ZodLiteral<"ping">]>;
}, z.core.$strip>;

The body of every delivery: the event, the resource it is about and the audit payload.

Released under the Apache-2.0 License.