Skip to main content
POST
/
v1
/
projects
/
{projectId}
/
webhooks
/
connections
cURL
curl -X POST \
  -H "X-API-Key: $PARTICLE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.particle.pro/v1/projects/{projectId}/webhooks/connections"
{
  "created_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "project_id": "<string>",
  "secret": "<string>",
  "secret_prefix": "<string>",
  "url": "<string>",
  "created_by": {
    "id": "<string>",
    "name": "<string>"
  },
  "name": "<string>",
  "revoked_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
X-API-Key
string
header
required

Pass your API key in the X-API-Key header (recommended).

Path Parameters

​
projectId
string
required

Project ID (base62-encoded).

Body

application/json
​
url
string
required

Destination URL. Must be https and resolve to a public address; private, loopback, and link-local addresses are rejected.

Required string length: 1 - 2000
​
name
string

Optional human label for the connection.

Maximum string length: 200

Response

OK

​
created_at
string<date-time>
required
​
id
string
required
​
project_id
string
required
​
secret
string
required

Signing secret — shown only at create/rotate time. Store it securely; it cannot be retrieved again. Used to verify the X-Webhook-Signature header on delivered payloads.

​
secret_prefix
string
required

Masked signing-secret prefix for identification. The full secret is shown only at create/rotate time and cannot be retrieved afterward.

​
surface
enum<string>
required

Which Particle surface this connection belongs to. Fixed at create time and inferred from the caller's authenticated surface context. A PLATFORM alert can only target a PLATFORM connection (and likewise for RADAR).

Available options:
PLATFORM,
RADAR
​
url
string
required

Destination URL that signed POSTs are delivered to.

​
created_by
object

User who created the connection. Null when created via an API key.

​
name
string

Optional human label for the connection.

​
revoked_at
string<date-time>

Set when the connection was deleted/revoked; absent for active connections. A revoked connection stops delivering and is skipped by alerts that still reference it.