Fetch a webhook endpoint by id.

GET

/v1/webhooks/endpoints/{id}

curl --request GET \
  --url https://api.asap.cool/v1/webhooks/endpoints/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

• Production

Authorizations

• api_key
  webhooks:read
• session

Parameters

Path Parameters

id

required

string format: uuid

Endpoint identifier.

Responses

200

The webhook endpoint.

Media type application/json

Public projection of a [WebhookEndpoint] (never exposes the secret).

object

created_at

required

Creation timestamp (RFC 3339).

string

enabled

required

Whether the endpoint is active.

boolean

events

required

Subscribed event tokens.

Array<string>

id

required

Stable identifier.

string format: uuid

url

required

Destination URL deliveries are POSTed to.

string

Example ^generated

{
  "created_at": "example",
  "enabled": true,
  "events": [
    "example"
  ],
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "url": "example"
}

401

No active org.

Media type application/json

Generic error body returned by API handlers when they fail. code is a stable machine-readable token; message is human-friendly and meant for surfacing to end users.

object

code

required

Stable machine token (e.g. invalid_credentials).

string

field

Offending request field for validation errors, when known.

string | null

message

required

Human-readable message.

string

Example ^generated

{
  "code": "example",
  "field": "example",
  "message": "example"
}

403

Missing webhooks:read scope.

Media type application/json

Generic error body returned by API handlers when they fail. code is a stable machine-readable token; message is human-friendly and meant for surfacing to end users.

object

code

required

Stable machine token (e.g. invalid_credentials).

string

field

Offending request field for validation errors, when known.

string | null

message

required

Human-readable message.

string

Example ^generated

{
  "code": "example",
  "field": "example",
  "message": "example"
}

404

Not found or cross-org.

Media type application/json

Generic error body returned by API handlers when they fail. code is a stable machine-readable token; message is human-friendly and meant for surfacing to end users.

object

code

required

Stable machine token (e.g. invalid_credentials).

string

field

Offending request field for validation errors, when known.

string | null

message

required

Human-readable message.

string

Example ^generated

{
  "code": "example",
  "field": "example",
  "message": "example"
}