Board

Set or update the board's webhook

Sets the board's webhook URL. Calling this again re-points an existing webhook (an update) rather than creating a second one — a board has at most one webhook.

A new webhookSigningKey is generated every time this is called, including on update, so re-pointing a webhook also rotates its signing key.

post/api/board/{boardId}/webhook

Request

Base URL
https://core-api.getaptly.com
Auth
- API key in header x-token
- or API key in header Authorization
TypeScript
https://skmtc.dev/getaptly/apis/aptly-api/docs/api/board/:boardId/webhook/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

boardIdstring required

Request body

webhookUrlstring required

Must be a valid http or https URL.

Response

Webhook set.

Changes

No recorded changes to this operation across all 1 revision of this API.