agency-board

POST `/v1/agency/boards/{boardId}/webhooks`

Add an outbound webhook.

அங்கீகாரம்

ஒரு பியரர் டோக்கனாக (bearer token) ஒரு API விசையை அனுப்பவும். இந்த எண்ட்பாயிண்ட் அதன் விவரக்குறிப்பில் குறிப்பிட்ட அனுமதியைக் குறிப்பிடவில்லை, எனவே அனுமானங்களைச் செய்வதற்குப் பதிலாக, உங்கள் விசைக்குத் தேவையான குறைந்தபட்ச அனுமதியை வழங்கவும் மற்றும் பதிலைச் சரிபார்க்கவும்.

இந்த எண்ட்பாயிண்டிற்கு எந்த அமைப்பு ஐடியும் (organisation id) தேவையில்லை. உங்கள் விசை (key) அது எந்த அமைப்புக்குரியது என்பதை ஏற்கனவே அடையாளம் காட்டுகிறது, மேலும் பதிலானது அதற்கேற்ப வரம்பிடப்பட்டுள்ளது.

முயன்று பார்

கோண அடைப்புக்குறிகளில் உள்ள எதையும் உங்கள் சொந்த மதிப்புகளுடன் மாற்றவும், மேலும் விசை பிளேஸ்ஹோல்டரை உங்கள் டாஷ்போர்டில் உள்ள விசையுடன் மாற்றவும்.

curl -X POST https://api.zinndigital.com/v1/agency/boards/{boardId}/webhooks \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "name": <string>, "url": <string> }'

உள்நுழைந்துள்ளீர்களா? உங்கள் டேஷ்போர்டில் உள்ள ஏபிஐ கன்சோல் உங்கள் உண்மையான நிறுவன ஐடி மற்றும் உங்கள் சொந்த சாவியை நிரப்புகிறது, மேலும் நேரலை ஏபிஐக்கு எதிராக கோரிக்கையை இயக்குகிறது, இதனால் நீங்கள் உண்மையான பதிலைக் காண முடியும். இந்த எண்ட்மார்க்கை ஏபிஐ கன்சோலில் திறக்கவும்

விவரங்கள்

HTTPS only. We mint the signing secret and return it **once, in this response**. There is no endpoint that can read it back, so keep it — rotate to get a new one. Deliveries are signed `X-Zinn-Signature: sha256=<hmac over "<timestamp>.<body>">` with `X-Zinn-Timestamp`, `X-Zinn-Delivery` and `X-Zinn-Event` beside them. The timestamp is bound INTO the signature so a captured request cannot be replayed for ever, and so a receiver cannot be tricked about which timestamp it was.

அளவுருக்கள்

பெயர்	வகை	தேவைப்படுகிறது	அது என்ன
`boardId (path)`	`Uuid`	ஆம்	Project board ID (UUIDv7).

கோரிக்கை உடல்

பெயர்	வகை	தேவைப்படுகிறது	அது என்ன
`name`	`string`	ஆம்	—
`url`	`string`	ஆம்	HTTPS only. Private and link-local addresses are refused when the socket opens, not when you save.
`events`	`string[]`	இல்லை	Empty means every event this board emits.
`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`	ஆம்	—
`url`	`string`	ஆம்	—
`events`	`string[]`	இல்லை	—
`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`	ஆம்	Whether a signing secret is stored. The secret itself is in Vault and is returned only by create and rotate; no endpoint can read it back.
`consecutive_failures`	`integer`	இல்லை	—
`suspended_reason`	`string`	இல்லை	Why we paused this webhook, in authored copy from a closed table — never an exception from our own code. It distinguishes your endpoint refusing a delivery, your endpoint being…
`suspended_at`	`string`	இல்லை	—
`last_delivered_at`	`string`	இல்லை	—
`last_failed_at`	`string`	இல்லை	—
`created_at`	`string`	இல்லை	—
`secret`	`string`	ஆம்	Shown ONCE, here. Store it now; rotate to get a new one.

இந்த எண்ட்ஸ்பாயிண்ட் திரும்ப அனுப்பக்கூடிய பிழைகள்

401 · 403 · 404 · 422

POST /v1/agency/boards/{boardId}/webhooks