Skip to content

Retrieve an endpoint

GET/v1/webhooks/{id}Key scope read

Returns one webhook endpoint. The signing secret is not included.

Needs a key with the read scope. Authentication

curl https://api.useinfrared.com/v1/webhooks/whe_2HLyVEWQelwo16welH16NM \
  -H "Authorization: Bearer $INFRARED_KEY"
200 OKResponse
{
  "object": "webhook_endpoint",
  "id": "whe_2HLyVEWQelwo16welH16NM",
  "project_id": "prj_0TBAgHGtdMketrbltGFHuk",
  "url": "https://example.com/webhooks/infrared",
  "description": "Marketplace backend",
  "event_types": ["moderation.completed", "queue_item.created"],
  "status": "active",
  "api_version": "2026-09-01",
  "consecutive_failures": 0,
  "disabled_at": null,
  "disabled_reason": null,
  "last_delivery_at": "2026-10-08T09:29:11.086Z",
  "last_success_at": "2026-10-08T09:29:11.086Z",
  "created_at": "2026-10-08T09:28:59.023Z",
  "updated_at": "2026-10-08T09:29:11.086Z"
}

Path parameters

idstringRequired

Id of the endpoint: whe_ plus 22 base62 characters.

Returns

The endpoint, without secret.

Errors

404
not_found

The key's project has no webhook endpoint with this id, or the id is malformed.

Every endpoint can also answer the errors any request can meet: a missing key, a rate limit, a malformed body. Errors

Something missing or unclear on this page? Write to support@useinfrared.com.