Sign in

v1

latestOpenAPI 3.0.12026-08-041753011.2 MB
Webhooks

Get logs for a webhook

post/v1/workspaces/{workspaceId}/webhooks/{webhookId}/logs

Path parameters

workspaceIdstring required

Represents a workspace identifier across the system.

Example:64a687e29ae1f428e7ebe303

Represents a workspace identifier across the system.

webhookIdstring required

Represents a webhook identifier across the system.

Represents a webhook identifier across the system.

Query parameters

pageinteger

Page number.

Example:1

Page number.

sizeinteger

Page size.

Example:50

Page size.

Request body

fromstring date-time

Represents date and time in yyyy-MM-ddThh:mm:ssZ format. If provided, results will include logs which occurred after this value.

sortByNewestboolean

If set to true, logs will be sorted with most recent first.

status'ALL' | 'SUCCEEDED' | 'FAILED'

Filters logs by status.

tostring date-time

Represents date and time in yyyy-MM-ddThh:mm:ssZ format. If provided, results will include logs which occurred before this value.

Example request

{
  "from": "2023-02-01T13:00:46Z",
  "to": "2023-02-05T13:00:46Z"
}

Response

OK

idstring

Represents log identifier across the system.

requestBodystring

Represents request body.

respondedAtstring

Represents date and time of response.

responseBodystring

Represents response body.

statusCodeinteger

Represents response status code.

webhookEventStatusIdstring

Represents webhook event status identifier across the system.

webhookIdstring

Represents webhook identifier across the system.

Example response

[
  {
    "id": "65e5b854fe0dfa24f1528ef0",
    "requestBody": "{\"id\":\"65df50f5d2dd8f23a685374e\",\"name\":\"Webhook\"}",
    "respondedAt": "2024-03-04T12:02:28.125+00:00",
    "responseBody": "{\"id\":\"h73210f5d2dd8f23685374e\",\"response\":\"Webhook response\"}",
    "statusCode": 200,
    "webhookEventStatusId": "6818c52b391aca499bf8dafc",
    "webhookId": "65df5508d2dd8f23a68537af"
  }
]