GET
/
webhooks
curl --request GET \
  --url https://app.formbricks.com/api/v2/management/webhooks \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "createdAt": "2021-01-01T00:00:00.000Z",
      "updatedAt": "2021-01-01T00:00:00.000Z",
      "url": "<string>",
      "source": "user",
      "environmentId": "<string>",
      "triggers": [
        "responseFinished"
      ],
      "surveyIds": [
        "<string>"
      ]
    }
  ],
  "meta": {
    "total": 123,
    "limit": 123,
    "offset": 123
  }
}

Authorizations

x-api-key
string
header
required

Use your Formbricks x-api-key to authenticate.

Query Parameters

limit
number
default:50

Number of items to return

Required range: 1 <= x <= 250
skip
number
default:0

Number of items to skip

Required range: x >= 0
sortBy
enum<string>
default:createdAt

Sort by field

Available options:
createdAt,
updatedAt
order
enum<string>
default:desc

Sort order

Available options:
asc,
desc
startDate
string

Start date

endDate
string

End date

surveyIds
string[]

Response

200 - application/json
Webhooks retrieved successfully.
data
object[]
meta
object

Was this page helpful?