Webhook Connections
tier:standard

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}

Request

  • Base URL: https://api.particle.pro
  • URL: https://api.particle.pro/v1/projects/{projectId}/webhooks/connections/{id}
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

projectIdstring required

Project ID (base62-encoded).

idstring required

Webhook connection ID (base62-encoded).

Response

OK

created_atstring date-time required
idstring required
namestring

Optional human label for the connection.

project_idstring required
revoked_atstring 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.

secret_prefixstring required

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

surface'PLATFORM' | 'RADAR' 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.

urlstring required

Destination URL that signed POSTs are delivered to.

Changes

No recorded changes to this operation across all 2 revisions of this API.