Skip to main content
GET
/
webhooks
List webhooks
curl --request GET \
  --url https://management.api.smartcar.com/v3/webhooks \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "webhook",
      "attributes": {
        "name": "Charging Webhook",
        "callbackUri": "https://example.com/webhook",
        "isEnabled": true,
        "triggers": [
          {
            "group": "SignalGroup",
            "name": "SignalName",
            "code": "signalCode"
          }
        ],
        "data": [
          {
            "group": "SignalGroup",
            "name": "SignalName",
            "code": "signalCode"
          }
        ],
        "errorCallbackUri": "https://example.com/webhook/errors",
        "autoSubscribe": false
      },
      "links": {
        "self": "https://management.api.smartcar.com/v3/webhooks/4b4ddadf-3219-4a2e-9ed0-c4d0f6d4f7ca"
      },
      "meta": {
        "createdAt": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "links": {
    "self": "/connections?page[number]=1&page[size]=10",
    "first": "/connections?page[number]=1&page[size]=10",
    "prev": null,
    "next": "/connections?page[number]=2&page[size]=10",
    "last": "/connections?page[number]=5&page[size]=10"
  },
  "meta": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalCount": 50
  }
}

Authorizations

​
Authorization
string
header
required

The Authorization header must be provided with a valid bearer token. Example: Authorization: Bearer {token}

Query Parameters

​
filter[name]
string

Filter webhooks by display name (partial match, case-insensitive)

​
filter[callbackUri]
string

Filter webhooks by callback URI (partial match, case-insensitive)

​
filter[isEnabled]
boolean

Filter webhooks by enabled status

​
filter[autoSubscribe]
boolean

Filter webhooks by auto-subscribe setting

​
page[number]
integer
default:1

Page number for pagination (JSON:API)

Required range: x >= 1
​
page[size]
integer
default:50

Number of resources per page (JSON:API)

Required range: 1 <= x <= 100

Response

List of webhooks for the authenticated application

​
data
object[]
required
​
links
object
required
Example:
{
  "self": "/connections?page[number]=1&page[size]=10",
  "first": "/connections?page[number]=1&page[size]=10",
  "prev": null,
  "next": "/connections?page[number]=2&page[size]=10",
  "last": "/connections?page[number]=5&page[size]=10"
}
​
meta
object
required
Example:
{
  "pageNumber": 1,
  "pageSize": 10,
  "totalCount": 50
}