v1

latestOpenAPI 3.0.02026-07-2494288373.8 KB
Webhooks

List all webhooks

Returns a list of all the webhooks endpoints registered to your Dotfile workspace.


See also

Learn more about Webhooks
Learn more about Filtering, Sorting and Pagination

get/v1/webhooks

Query parameters

namestring

Filter items by the name.{operator} field.
You can use the eq, not_eq, like and ilike operators, the eq operator being the default.

created_atstring

Date (yyyy-MM-dd eg 2023-01-31) or date time (yyyy-MM-ddTHH:mm:ss.S+X eg 2023-01-31T13:30:00.000Z) in format ISO 8601

Filter items by the created_at.{operator} field.
You can use the eq, not_eq, gt, gte, lt and lte operators, the eq operator being the default.

updated_atstring

Date (yyyy-MM-dd eg 2023-01-31) or date time (yyyy-MM-ddTHH:mm:ss.S+X eg 2023-01-31T13:30:00.000Z) in format ISO 8601

Filter items by the updated_at.{operator} field.
You can use the eq, not_eq, gt, gte, lt and lte operators, the eq operator being the default.

status'online' | 'offline'

Filter items by the status.{operator} field.
You can use the eq and not_eq operators, the eq operator being the default.

type'user' | 'system'

Filter items by the type.{operator} field.
You can use the eq and not_eq operators, the eq operator being the default.

urlstring

Filter items by the url.{operator} field.
You can use the eq, not_eq, like and ilike operators, the eq operator being the default.

eventsstring

Filter items by the events.{operator} field.
You can use the array_contains, array_not_contains and array_overlap operators, the array_contains operator being the default.
Comma separated for multiple values (array_contains, array_not_contains and array_overlap).

sortstring

Use this parameter to sort query results.
If not specified, sorted in ascending order with values of field updated_at.
Available fields are created_at, name, status, type, updated_at and url.

pagenumber

Query response is paginated.
Use this parameter to choose which page you want to display.
Page index starts at 1 (the default).

limitnumber

Query response is paginated.
Use this parameter to choose the number of items per page.
Limit defaults to 20, maximum value is 100.

Response

List of webhooks registered with the workspace

ℹ️ Click to see full payload

Example response

{
  "pagination": {
    "count": 42
  }
}