---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Get an inbound endpoint"
description: "`events.inbound_endpoints.get` (GET /v1/{name}): Gets an inbound endpoint."
type: reference
product: webhooks
summary: "Gets an inbound endpoint."
updated: 2026-09-28
nav: false
---

> **This method is not served on the public API.** `api.sylphx.com` does not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.

Gets an inbound endpoint.

- **Path** `GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/inbound_endpoints/inbound-endpoint`
- **Scope** `events:read`
- **Effect** `read` — nothing is written.
- **Collection** [inbound_endpoints](/docs/api/inbound_endpoints)

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | The name of the inbound endpoint to get. Required. |

## Response

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/inbound_endpoints/{inbound_endpoint}`. |
| `uid` | `string` | `ibe_<cell><ulid>`; never reused. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `spec` | `InboundEndpointSpec` | Desired state. Required. |
| `status` | `InboundEndpointStatus` | Observed state. Output only. |

### ResourceMeta

| Field | Type | What it is |
| --- | --- | --- |
| `generation` | `int64` | Increases by one on every change to `spec`. Output only. |
| `etag` | `string` | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as `If-Match` or `etag` to make Update and Delete conditional; a mismatch fails with ABORTED / 409 `ETAG_MISMATCH`. Output only. |
| `create_time` | `timestamp` | When the Resource was created. Output only. |
| `update_time` | `timestamp` | When the Resource last changed. Output only. |
| `delete_time` | `timestamp` | Set while the Resource is being deleted. Output only. |
| `labels` | `map<string, string>` | Caller-writable, indexed labels (AIP-122 label rules). |
| `annotations` | `map<string, string>` | Caller-writable, unindexed annotations. |
| `display_name` | `string` | Caller-writable human-readable name. |
| `creator` | `string` | The principal that created the Resource. Output only. |

### InboundEndpointSpec

| Field | Type | What it is |
| --- | --- | --- |
| `signature_scheme` | `InboundSignatureScheme` | The sender's signature scheme. Required. One of `standard_webhooks`, `stripe`, `shopify`, `github`. |
| `verification_secret` | `string` | The provider's verification secret, held in Sylphx Secrets. Required. |
| `topic` | `string` | The Topic verified requests are published to. Required. |
| `source` | `string` | The CloudEvents `source` of published events; default the endpoint name. |

### InboundEndpointStatus

| Field | Type | What it is |
| --- | --- | --- |
| `observed_generation` | `int64` | The generation this status was computed from. Output only. |
| `conditions` | `Condition[]` | Ready, Reconciling, Stalled. Output only. |
| `receive_uri` | `string` | The URI to give the provider. Output only. |
| `last_receive_time` | `timestamp` | The last verified request. Output only. |
| `rejected_count` | `int64` | Requests refused for a bad signature, all time. Output only. |

### Condition

| Field | Type | What it is |
| --- | --- | --- |
| `type` | `string` | The condition type, for example `Ready`. |
| `status` | `ConditionStatus` | Whether the condition holds. One of `true`, `false`, `unknown`. |
| `observed_generation` | `int64` | The generation this observation was made against. |
| `reason` | `string` | A machine-readable UpperCamelCase reason. |
| `message` | `string` | A customer-safe human-readable message. |
| `severity` | `Severity` | How severe a FALSE condition is. One of `info`, `warning`, `error`. |
| `transition_time` | `timestamp` | When `status` last changed. |

## Errors

- [`UNAUTHENTICATED`](/docs/api/errors/UNAUTHENTICATED) — No valid key or token was presented.
- [`PERMISSION_DENIED`](/docs/api/errors/PERMISSION_DENIED) — The key lacks the method's permission.
- [`RESOURCE_NOT_FOUND`](/docs/api/errors/RESOURCE_NOT_FOUND) — The named Resource does not exist or is not visible.

Every error arrives in the body [Errors](/docs/platform/errors) describes.

## Examples

**cURL**

```curl
curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/inbound_endpoints/inbound-endpoint" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"
```

**TypeScript**

```ts
const response = await sylphx.events.inboundEndpoints.get({ name: 'orgs/acme/projects/shop/envs/production/inbound_endpoints/inbound-endpoint' })
```

**Rust**

```rust
let mut req = sylphx::events::GetInboundEndpointRequest::default();
req.name = "orgs/acme/projects/shop/envs/production/inbound_endpoints/inbound-endpoint".to_string();
let response = sx.events().inbound_endpoints().get(req).await?;
```

**CLI**

```bash
sylphx events inbound-endpoints get orgs/acme/projects/shop/envs/production/inbound_endpoints/inbound-endpoint
```

**Terraform**

```hcl
data "sylphx_events_inbound_endpoint" "inbound_endpoint" {
  name = "orgs/acme/projects/shop/envs/production/inbound_endpoints/inbound-endpoint"
}
```

**MCP**

```json
{ "method_id": "events.inbound_endpoints.get", "args": {"name":"orgs/acme/projects/shop/envs/production/inbound_endpoints/inbound-endpoint"} }
```