agency-board

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

Change a webhook, or pause and resume it.

සත්‍යාපනය

බෙරර් ටෝකනයක් ලෙස API යතුරක් යවන්න. මෙම අන්ත ලක්ෂ්‍යය පිරිවිතරයේ නිශ්චිත අවසරයක් දක්වා නැත, එබැවින් උපකල්පනය කරනවාට වඩා ඔබේ යතුරට අවශ්‍ය අවම අවසරය ලබා දී ප්‍රතිචාරය පරීක්ෂා කරන්න.

මෙම අවසාන ලක්ෂ්‍යය සඳහා සංවිධාන හැඳුනුම්පතක් (organisation id) අවශ්‍ය නොවේ. ඔබගේ යතුර මඟින් එය අයත් වන සංවිධානය දැනටමත් හඳුනා ගන්නා අතර, ප්‍රතිචාරය ඒ වෙත සීමා වේ.

උත්සාහ කරන්න

<අගයන්> සමඟ කෝණික වරහන් තුළ ඇති ඕනෑම දෙයක් සහ ඔබේ උපකරණ පුවරුවෙන් ලබාගත් යතුරක් සමඟ key ස්ථාන දායකය ප්‍රතිස්ථාපනය කරන්න.

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 කොන්සෝලය මඟින් ඔබේ සැබෑ ආයතනික හැඳුනුම්පත සහ ඔබේම යතුර පුරවා, සජීවී 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>`	නැත	—

පsspil

නම	වර්ගය	අත්‍යවශ්‍යයි	එය කුමක්ද
`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}