---
title: "Create portal endpoint"
method: POST
path: "/api/v1/portal/endpoints"
tags: ["Portal"]
---

# Create portal endpoint

`POST /api/v1/portal/endpoints`

## Request

- Base URL: `http://localhost:8080`
- URL: `http://localhost:8080/api/v1/portal/endpoints`
- Auth: HTTP bearer

Registers an endpoint for the consumer. The signing secret is in this response only.

## Request body

- PortalEndpointRequest
  - `url` string, required
  - `description` string
  - `enabled` boolean
  - `eventTypes` string[]: The event types this Endpoint receives. Replaces the current set; absent leaves it alone. Wildcards: order.* (one segment), order.** and ** (everything).

## Response `201`

Endpoint created

## Other responses

- `402`: The project has reached its plan's endpoint limit

---

[API](https://skmtc.dev/railhook/apis/railhook-api.md) · [All operations](https://skmtc.dev/railhook/apis/railhook-api/llms.txt) · [OpenAPI document](https://skmtc.dev/railhook/apis/railhook-api/revisions/4e2c76dfc33d?raw)
