Register a workspace webhook endpoint

Registers a signed webhook endpoint. Stored workspace API keys force server-side workspace, owner, and key metadata onto the endpoint, ignoring client-supplied workspace fields.

post/v1/webhooks

Request

  • Base URL: https://api.uploadcheck.app
  • URL: https://api.uploadcheck.app/v1/webhooks
  • Auth: HTTP bearer

Request body

urlstring required
event_typesstring[]

Response

Webhook registered

webhookIdstring
urlstring
eventTypesstring[]
workspaceIdstring nullable

Workspace that owns this webhook endpoint. Stored workspace API keys are pinned to this value.

ownerEmailstring nullable
apiKeyIdstring nullable
signingSecretPreviewstring
signingSecretstring

Returned once on creation.

signingSecretStorage'encrypted' | 'plaintext'

Changes

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