Webhooks

🚧

The Testify API is still in alpha and is subject to change without notice. Please contact us if you have any questions.

Get all webhooks, add a webhook, delete a webhook, or check the invocation history of a webhook.

Valid Webhook Events

[
  "case:create",
  "case:update",
  "case:delete",
  "milestone:create",
  "milestone:update",
  "milestone:delete",
  "project:create",
  "project:update",
  "project:delete",
  "run:create",
  "run:update",
  "run:delete",
  "test:update",
  "test:delete"
]

`GET /v1/webhooks`

Get all webhooks for your organization.

Response Body

{
  webhooks: {
    id: string;
    url: string;
    createdAt: Date;
    webhookEvent: "case:create" | "case:update" | "case:delete" | "milestone:create" | "milestone:update" | "milestone:delete" | "project:create" | "project:update" | "project:delete" | "run:create" | "run:update" | "run:delete" | "test:update" | "test:delete";
  }[];
}

`PUT /v1/webhooks`

Create a new webhook.

Request Body

{
  url: string;
  webhookEvent: "case:create" | "case:update" | "case:delete" | "milestone:create" | "milestone:update" | "milestone:delete" | "project:create" | "project:update" | "project:delete" | "run:create" | "run:update" | "run:delete" | "test:update" | "test:delete";
}

Response Body

{
  webhook: {
    id: string;
    url: string;
    createdAt: Date;
    webhookEvent: "case:create" | "case:update" | "case:delete" | "milestone:create" | "milestone:update" | "milestone:delete" | "project:create" | "project:update" | "project:delete" | "run:create" | "run:update" | "run:delete" | "test:update" | "test:delete";
  };
}

`DELETE /v1/webhooks/:webhookId`

Delete a webhook.

Response Body

A successful response will return a response with a status code of 200 and no data parameter:

{
  "ok": true,
  "requestId": string,
  "duration": number,
}

`GET /v1/webhooks/history/:webhookId`

Get the invocation history of a webhook.

Response Body

{
  history: {
    request: string;
    response: string;
    statusCode: number;
    timestamp: Date;
  }[];
}

Users