agency-board

PATCH `/v1/agency/boards/{boardId}/webhooks/{webhookId}`

Change a webhook, or pause and resume it.

ದೃಢೀಕರಣ

ಬೀರರ್ ಟೋಕನ್ ಆಗಿ API ಕೀಯನ್ನು ಕಳುಹಿಸಿ. ಈ ಎಂಡ್‌ಪಾಯಿಂಟ್ ಸ್ಪೆಸಿಫಿಕೇಶನ್‌ನಲ್ಲಿ ನಿರ್ದಿಷ್ಟ ಅನುಮತಿಯನ್ನು ಸೂಚಿಸುವುದಿಲ್ಲ, ಆದ್ದರಿಂದ ಊಹಿಸುವ ಬದಲು ನಿಮ್ಮ ಕೀಗೆ ಕನಿಷ್ಠ ಅಗತ್ಯವಿರುವದನ್ನು ನೀಡಿ ಮತ್ತು ಪ್ರತಿಕ್ರಿಯೆಯನ್ನು ಪರಿಶೀಲಿಸಿ.

ಈ ಎಂಡ್‌ಪಾಯಿಂಟ್ ಯಾವುದೇ ಸಂಸ್ಥೆಯ ಐಡಿಯನ್ನು ತೆಗೆದುಕೊಳ್ಳುವುದಿಲ್ಲ. ನಿಮ್ಮ ಕೀ ಯು ಈಗಾಗಲೇ ಅದು ಸೇರಿರುವ ಸಂಸ್ಥೆಯನ್ನು ಗುರುತಿಸುತ್ತದೆ ಮತ್ತು ಪ್ರತಿಕ್ರಿಯೆಯನ್ನು ಅದಕ್ಕೆ ಸೀಮಿತಗೊಳಿಸಲಾಗಿದೆ.

ಪ್ರಯತ್ನಿಸಿ

ಕೋನೀಯ ಬ್ರಾಕೆಟ್‌ಗಳಲ್ಲಿರುವ ಯಾವುದೇ ಅಂಶವನ್ನು ನಿಮ್ಮ ಸ್ವಂತ ಮೌಲ್ಯಗಳೊಂದಿಗೆ ಮತ್ತು ಕೀ ಪ್ಲೇಸ್‌ಹೋಲ್ಡರ್ ಅನ್ನು ನಿಮ್ಮ ಡ್ಯಾಶ್‌ಬೋರ್ಡ್‌ನಲ್ಲಿರುವ ಕೀಯೊಂದಿಗೆ ಬದಲಾಯಿಸಿ.

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

ಸೈನ್ ಇನ್ ಆಗಿದ್ದೀರಾ? ನಿಮ್ಮ ಡ್ಯಾಶ್‌ಬೋರ್ಡ್‌ನಲ್ಲಿರುವ API ಕನ್ಸೋಲ್ ನಿಮ್ಮ ನೈಜ ಸಂಸ್ಥೆಯ ID ಮತ್ತು ನಿಮ್ಮ ಸ್ವಂತ ಕೀಲಿಯನ್ನು ಭರ್ತಿ ಮಾಡುತ್ತದೆ, ಮತ್ತು ಲೈವ್ API ವಿರುದ್ಧ ವಿನಂತಿಯನ್ನು ರನ್ ಮಾಡುತ್ತದೆ ಆದ್ದರಿಂದ ನೀವು ನಿಜವಾದ ಪ್ರತಿಕ್ರಿಯೆಯನ್ನು ನೋಡಬಹುದು. API ಕನ್ಸೋಲ್‌ನಲ್ಲಿ ಈ ಎಂಡ್‌ಪಾಯಿಂಟ್ ತೆರೆಯಿರಿ

ಪ್ಯಾರಾಮೀಟರ್‌ಗಳು

ಹೆಸರು	ಪ್ರಕಾರ	ಅಗತ್ಯವಿದೆ	ಏನಿದು
`boardId (path)`	`Uuid`	ಹೌದು	Project board ID (UUIDv7).
`webhookId (path)`	`Uuid`	ಹೌದು	Outbound webhook subscription 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`	ಇಲ್ಲ	—

ಈ ಎಂಡ್‌ಪಾಯಿಂಟ್ ಹಿಂತಿರುಗಿಸಬಹುದಾದ ದೋಷಗಳು

401 · 403 · 404 · 422

PATCH /v1/agency/boards/{boardId}/webhooks/{webhookId}