Documentation
- Getting Started
- Authentication
- Making Requests
- Resource Creation
- Searching
- Plugins
- Webhooks
Tutorials
APIs
- Activity Codes
- Archive
- Authorization
- Bank Accounts
- Contacts
- Events
- Expenses
- Fees
- Files
- Firm
- Firm Users
- Folders
- Invoices
- Layout Designs
- Layout Matter Items
- Matter Billing Configuration
- Matter Items
- Matter Types
- Matters
- Memos
- Notifications
- Plugins
- Referral Types
- Relationships
- Roles
- Staff
- Stages
- Subscription Payments
- Subscription Promotions
- Subscriptions
- Tasks
- Users
- Webhooks
Webhooks
Get webhook subscriptions
Returns existing webhook subscriptions.
GET
/
webhooks
curl --request GET \
--url https://api.smokeball.com/webhooks \
--header 'Authorization: <api-key>' \
--header 'x-api-key: <api-key>'
{
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "GET",
"self": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "GET"
},
"value": [
{
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "GET",
"self": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
},
"accountId": "da4e7fd1-5394-4ca9-b1c6-e18c4e2bf262",
"name": "Listen to matter and contact changes",
"eventTypes": [
"matter.updated",
"contact.created"
],
"eventNotificationUrl": "http://yourdomain.com/notify",
"createdDateUtc": "2022-04-23T14:00:00Z",
"updatedDateUtc": "2022-04-23T14:00:00Z",
"lastUpdated": 637847425252027400
}
],
"offset": 123,
"limit": 123,
"size": 123,
"first": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
},
"previous": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
},
"next": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
},
"last": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
}
}
Query Parameters
Required range:
0 <= x <= 2147483647
Required range:
1 <= x <= 500
Response
200
application/json
When request is successful. Returns existing webhook subscriptions.
The response is of type object
.
curl --request GET \
--url https://api.smokeball.com/webhooks \
--header 'Authorization: <api-key>' \
--header 'x-api-key: <api-key>'
{
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "GET",
"self": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "GET"
},
"value": [
{
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "GET",
"self": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
},
"accountId": "da4e7fd1-5394-4ca9-b1c6-e18c4e2bf262",
"name": "Listen to matter and contact changes",
"eventTypes": [
"matter.updated",
"contact.created"
],
"eventNotificationUrl": "http://yourdomain.com/notify",
"createdDateUtc": "2022-04-23T14:00:00Z",
"updatedDateUtc": "2022-04-23T14:00:00Z",
"lastUpdated": 637847425252027400
}
],
"offset": 123,
"limit": 123,
"size": 123,
"first": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
},
"previous": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
},
"next": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
},
"last": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
}
}