{
"opencollection": "1.0.0",
"info": {
"name": "Samsara Webhooks API",
"version": "2024-11-18"
},
"request": {
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"items": [
{
"info": {
"name": "Webhooks",
"type": "folder"
},
"items": [
{
"info": {
"name": "List All Webhooks Belonging to a Specific Org.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.samsara.com/webhooks",
"params": [
{
"name": "ids",
"value": "",
"type": "query",
"description": " A filter on the data based on this comma-separated list of webhook IDs. Example: `ids=49412323223,49412329928`"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The limit for how many objects will be in the response. Default and max for this value is 512 objects."
},
{
"name": "after",
"value": "",
"type": "query",
"description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results."
}
]
},
"docs": "List all webhooks belonging to a specific org.\n\n Rate limit: 5 requests/sec (learn more about rate limits here).\n\nTo use this endpoint, select **Read Webhooks** under the Setup & Administration category when creating or editing an API token. Learn More.\n \n\n **Submit Feedback**: Likes, dislikes, and API feature "
},
{
"info": {
"name": "Create a Webhook",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.samsara.com/webhooks",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a webhook\n\n Rate limit: 100 requests/min (learn more about rate limits here).\n\nTo use this endpoint, select **Write Webhooks** under the Setup & Administration category when creating or editing an API token. Learn More.\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as"
},
{
"info": {
"name": "Retrieve a Webhook With Given ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.samsara.com/webhooks/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the webhook. This is the Samsara-specified ID."
}
]
},
"docs": "Retrieve a webhook with given ID.\n\n Rate limit: 5 requests/sec (learn more about rate limits here).\n\nTo use this endpoint, select **Read Webhooks** under the Setup & Administration category when creating or editing an API token. Learn More.\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests shou"
},
{
"info": {
"name": "Update a Specific Webhook's Information.",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.samsara.com/webhooks/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Unique identifier for the webhook to update."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update a specific webhook's information. **Note** this implementation of patch uses [the JSON merge patch](https://tools.ietf.org/html/rfc7396) proposed standard.\n This means that any fields included in the patch request will _overwrite_ fields which exist on the target resource.\n For arrays, this means any array included in the request will _replace_ the array that exists at the specified path, it will not _add_ to the existing array\n\n Rate limit: 100 requests/min (learn more about rate"
},
{
"info": {
"name": "Delete a Webhook With the Given ID",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.samsara.com/webhooks/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Unique identifier for the webhook to delete."
}
]
},
"docs": "Delete a webhook with the given ID.\n\n Rate limit: 100 requests/min (learn more about rate limits here).\n\nTo use this endpoint, select **Write Webhooks** under the Setup & Administration category when creating or editing an API token. Learn More.\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests"
}
]
}
],
"bundled": true
}