curl -H "X-API-Key: $PARTICLE_API_KEY" \
"https://api.particle.pro/v1/projects/{projectId}/webhooks/connections/{id}"{
"created_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"project_id": "<string>",
"secret_prefix": "<string>",
"surface": "PLATFORM",
"url": "<string>",
"created_by": {
"id": "<string>",
"name": "<string>"
},
"name": "<string>",
"revoked_at": "2023-11-07T05:31:56Z"
}{
"detail": "Property foo is required but is missing.",
"error_code": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"resolve": {
"message": "<string>",
"action": "<string>",
"endpoint": "<string>",
"method": "<string>",
"url": "<string>"
},
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}Webhook Connections
Get a webhook connection
Returns a single webhook connection. The signing secret is never returned — only its masked prefix.
GET
/
v1
/
projects
/
{projectId}
/
webhooks
/
connections
/
{id}
curl -H "X-API-Key: $PARTICLE_API_KEY" \
"https://api.particle.pro/v1/projects/{projectId}/webhooks/connections/{id}"{
"created_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"project_id": "<string>",
"secret_prefix": "<string>",
"surface": "PLATFORM",
"url": "<string>",
"created_by": {
"id": "<string>",
"name": "<string>"
},
"name": "<string>",
"revoked_at": "2023-11-07T05:31:56Z"
}{
"detail": "Property foo is required but is missing.",
"error_code": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"resolve": {
"message": "<string>",
"action": "<string>",
"endpoint": "<string>",
"method": "<string>",
"url": "<string>"
},
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}Prefer the terminal? This endpoint is also a command in the Particle CLI: pick Particle CLI in the request example’s language menu. Install the Particle CLI.
Authorizations
ApiKeyHeaderBearerAuth
Path Parameters
Response
OK
Which Particle surface created this connection. Fixed at create time and inferred from the caller's authenticated surface context. Provenance only — an alert on either surface can deliver through it. Render it to show where the endpoint was registered.
Available options:
PLATFORM, RADAR Was this page helpful?