Retrieve the list of webhooks
The endpoint allows you to retrieve the list of existing webhooks available for the current account
Request schema
Query parameters
cursor
string
Paging cursor, read more about pagination
example:
limit
integer
Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.
format:
example:
Header parameters
Authorization
stringrequired
HTTP: basicAuth
HTTP AuthorizationScheme: basic
Accept
string
default:
example:
Http + 1.1
GET
https://api.fivetran.com/v1/webhooks
GET /v1/webhooks?cursor=trDfa54Ffs9hj&limit=100 HTTP/1.1
Accept: application/json
Authorization: Basic <Replace with base64-encoded key>
Host: api.fivetran.com
Responses
200
Successful response
Successful response schema
code
stringrequired
Response status code
example:
message
string
Response status text
example:
data
objectrequired
items
arrayrequired
The collection of returned items
id
stringrequired
The webhook ID.
example:
type
stringrequired
The webhook type.
enum:
url
stringrequired
Your webhooks URL endpoint for your application.
example:
events
arrayrequired
The array of event types.
example:
type:
active
booleanrequired
Boolean, if set to true, webhooks are immediately sent in response to events.
example:
secret
string
The secret string used for payload signing.
example:
created_at
stringrequired
The webhook creation timestamp.
format:
example:
created_by
stringrequired
The ID of the user who created the webhook.
example:
group_id
string
The group ID.
example:
next_cursor
string
The value of the cursor parameter for the next page
example:
{
"code": "Success",
"message": "Operation performed.",
"data": {
"items": [
{
"id": "webhook_id",
"type": "group",
"url": "https://your-host.your-domain/webhook",
"events": [
"sync_start",
"sync_end"
],
"active": true,
"secret": "******",
"created_at": "2024-01-01T00:00:00Z",
"created_by": "user_id",
"group_id": "group_id"
}
],
"next_cursor": "cursor_value"
}
}