Get Webhooks

Get all webhooks under your account.

GET /webhooks

Try it

Get all webhooks

cURL

curl --request GET \
  --url https://api.trench.dev/webhooks

200

{
  "limit": 123,
  "offset": 123,
  "total": 123,
  "results": [
    {
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "url": "https://your-webhook-url.com",
      "enableBatching": true,
      "createdAt": "2021-01-01T00:00:00.000Z",
      "eventTypes": [
        "page",
        "track",
        "identify",
        "group"
      ],
      "eventNames": [
        "UserSignedUp",
        "UserLoggedIn"
      ],
      "flatten": true
    }
  ]
}

This endpoint requires your private API key.

Response

200 - application/json

The webhooks have been successfully retrieved. Requires private API key in Bearer token.

limit · number | null · required

The limit of the pagination.

offset · number | null · required

The offset of the pagination.

total · number | null · required

The total number of results. If null, the total is unknown.

results · object[] · required

Show child attributes

results. uuid · string · required

The UUID of the webhook. Automatically generated.

Example:

"123e4567-e89b-12d3-a456-426614174000"

results. url · string · required

The URL that the webhook will send events to.

Example:

"https://your-webhook-url.com"

results. enableBatching · boolean · required

Whether to enable batching for the webhook.

Example:

true

results. createdAt · string<date-time> · required

The date and time the webhook was created.

Example:

"2021-01-01T00:00:00.000Z"

results. eventTypes · string[] · required

The event types that the webhook will send. Use * to match all event types.

Example:

["page", "track", "identify", "group"]

results. eventNames · string[] · required

The event names that the webhook will send. Use * to match all event names.

Example:

["UserSignedUp", "UserLoggedIn"]

results. flatten · boolean · required

Whether to flatten the event data. This is useful for downstream systems that don't support nested data structures.

Example:

true