Webhooks
get all
Retrieve the list of webhooks configured for the campaign
For custom components:
RaiselyComponents.api.all('webhooks').get(params = {}, headers = {}) => Promise<{result}>
:fa-gears: See Restie Response Data for a more detailed overview of responses through the client wrapper
get/webhooks
Query parameters
campaignstring required
The uuid, path or domain of the campaign to associate with the request
privateboolean
Returns the full record when authenticated
qstring
Search query to find records matching
limitnumber
The number of records to limit per page
offsetnumber
The pagination offset (in number of records)
sortstring
The record attribute to filter on (use in conjunction with order)
order'asc' | 'desc'
The direction to sort (only applied if sort is also provided) * asc - Ascending * desc - Descending
Headers
Authorizationstring
A valid HTTP Bearer token, required to access private records.
Response
A list of webhooks
Example response
{
"data": [
{
"uuid": "f89f8270-4a7e-11eb-930b-390f490b0615",
"createdAt": "2020-12-30T09:11:16.247Z",
"campaignUuid": "f2a3bcb0-96d8-11e9-8a7b-47a01a90ec39",
"url": "https://myapp.com/raisely"
}
],
"pagination": {
"total": 10,
"pages": 2,
"offset": 5,
"limit": 5
}
}