agency-board
POST /v1/agency/boards/{boardId}/inbound-endpoints
Create an inbound endpoint.
احراز هویت
یک کلید API را به عنوان یک توکن برbearer ارسال کنید. این نقطه پایانی مجوز خاصی را در مشخصات خود ذکر نمیکند، بنابراین به جای فرض کردن، حداقل نیازهای کلید خود را بدهید و پاسخ را بررسی کنید.
این نقطه پایانی هیچ شناسه سازمانی را دریافت نمیکند. کلید شما در حال حاضر سازمان مربوطه را مشخص میکند و پاسخ در همان محدوده ارائه میشود.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
curl -X POST https://api.zinndigital.com/v1/agency/boards/{boardId}/inbound-endpoints \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string> }'وارد شدهاید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر میکند و درخواست را روی API زنده اجرا میکند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید
جزئیات
Returns the full URL to paste into the sending system, and the secret **once**. The URL carries one opaque key, not the board id — so it leaks no internal identifier into somebody else's logs, and rotating the secret does not change the URL. Tenancy comes off the endpoint row and never out of the POSTed body, which is what makes it unforgeable across tenants.
پارامترها
| نام | نوع | الزامی | چیست |
|---|---|---|---|
boardId (path) | Uuid | بله | Project board ID (UUIDv7). |
بدنه درخواست
| نام | نوع | الزامی | چیست |
|---|---|---|---|
name | string | بله | — |
signature_scheme | string<zinn, github> | خیر | `zinn` verifies `X-Zinn-Signature` over "<timestamp>.<body>"; `github` verifies GitHub's own `X-Hub-Signature-256` over the body. One route, one rate limiter, one log, whichever… |
status | string<enabled, disabled> | خیر | — |
پاسخ
| نام | نوع | الزامی | چیست |
|---|---|---|---|
id | Uuid | بله | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
board_id | Uuid | بله | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
name | string | بله | — |
endpoint_key | string | بله | The opaque path segment. Not the board id, and unchanged by a secret rotation. |
url | string | خیر | The full URL to paste into the sending system. |
signature_scheme | string<zinn, github> | بله | — |
status | BoardAutomationStatus | بله | `suspended` means WE paused it after repeated failure and it carries a reason the customer has not read. It is a third state rather than a reuse of `disabled`, because collapsin… |
has_secret | boolean | بله | — |
request_count | integer | خیر | — |
rejected_count | integer | خیر | — |
last_rejection | string | خیر | Why the last refused request was refused — so "my n8n node says 404" is answerable from this screen rather than from a support ticket. |
last_seen_at | string | خیر | — |
created_at | string | خیر | — |
secret | string | بله | Shown ONCE, here. |
خطاهایی که این نقطه پایانی میتواند برگرداند
401 · 403 · 404 · 422