Skip to main content
GET
cURL

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).

id
string
required

Webhook connection ID (base62-encoded).

Response

OK

created_at
string<date-time>
required
id
string
required
project_id
string
required
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 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
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.