agency-board

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

Change a webhook, or pause and resume it.

પ્રમાણીકરણ

બિયરર ટૉકન તરીકે API કી મોકલો. આ એન્ડપૉઇન્ટ સ્પેશિફિકેશનમાં કોઈ ચોક્કસ પરવાનગી જણાવતું નથી, તેથી ધારણા બાંધવાને બદલે તમારી કીને તેની જરૂરિયાત મુજબ ન્યૂનતમ પરવાનગી આપો અને રિસ્પોન્સ તપાસો.

આ એન્ડપૉઇન્ટ કોઈ સંસ્થા આઈડી (organisation id) લેતું નથી. તમારી કી (key) પહેલેથી જ તે જે સંસ્થા સાથે સંબંધિત છે તેની ઓળખ કરે છે, અને પ્રતિસાદ (response) તે જ પૂરતો મર્યાદિત છે.

આયમાવો

કોઈપણ કૌંસમાં રહેલી બાબતને તમારા પોતાના મૂલ્યોથી બદલો અને કી પ્લેસહોલ્ડરને તમારા ડેશબોર્ડની કીથી બદલો.

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>`	ના	—

જવાબ

નામ	પ્રકાર	જરૂરી	તે શું છે
`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}