Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Uploadcare

Uploadcare Webhook API

The Webhook API from Uploadcare — 3 operation(s) for webhook.

Documentation Provider Profile APIs.io OpenAPI GitHub

Uploadcare Webhook API is one of 11 APIs that Uploadcare publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Webhook. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 3 paths, and defines 32 schemas. It is described by OpenAPI 3.0.0, at version 2022-11-28.

Requests are made against a single base URL, https://ucarecdn.com.

4 operations 3 paths 32 schemas 1 DELETE1 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2022-11-28
Base URL
https://api.uploadcare.com
Contact
API support
Resource Areas
1

Paths & Operations 4

Across 3 paths, the API surfaces 4 operations — 1 DELETE, 1 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Webhook 4
GET
/webhooks/
List of webhooks
webhooksList 1 param → 200400401406429
POST
/webhooks/
Create webhook
webhookCreate 1 param body → 201400401406429
PUT
/webhooks/{id}/
Update webhook
updateWebhook 2 params body → 200401404406429
DELETE
/webhooks/unsubscribe/
Delete webhook
webhookUnsubscribe 1 param body → 204400401406429

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are file (15 properties), webhookPublicInfo (9 properties), webhook_of_list_response (9 properties), imageInfo (9 properties). Each schema is shown below with its type and property counts.

contentInfo
object
Information about file content.
3 properties
webhook_version_of_request
string
Webhook payload's version.
webhook_is_active
boolean
Marks a subscription as either active or not, defaults to true, otherwise false.
webhook_event
string
An event you subscribe to.
webhook_signing_secret
string
Optional [HMAC/SHA-256](https://en.wikipedia.org/wiki/HMAC) secret that, if set, will be used to calculate signatures for the webhook payloads sent to the targ…
webhook_updated
string
date-time when a webhook was updated.
webhook_of_list_response
object
Webhook.
9 properties
awsRekognitionDetectModerationLabels_v2016_06_27
videoInfo
object
Video metadata.
5 properties 5 required
webhookFilePayload
object
4 properties 4 required
webhook_project_pubkey
string
Public project key the webhook belongs to.
webhook
object
Webhook.
9 properties
ucClamavVirusScan
applicationDataObject
object
Dictionary of application names and data associated with these applications.
4 properties
cantUseWebhooksError
object
1 property
webhookPublicInfo
object
Public Webhook information (does not include secret data like signingsecret)
9 properties 8 required
removeBg_v1_0
webhook_id
integer
Webhook's ID.
awsRekognitionDetectLabels_v2016_06_27
webhook_version_of_list_response
string
Webhook payload's version.
webhook_version
string
Webhook payload's version.
metadata
object
Arbitrary metadata associated with a file.
webhookTargetUrlError
object
1 property
webhookFileInfoUpdatedPayload
object
5 properties 5 required
webhook_project
integer
Project ID the webhook belongs to.
file
object
15 properties 14 required
webhookInitiator
object
Webhook event initiator.
2 properties 2 required
webhook_created
string
date-time when a webhook was created.
imageInfo
object
Image metadata.
9 properties 9 required
applicationData
object
4 properties 4 required
simpleAuthHTTPForbidden
object
1 property
webhook_target
string
A URL that is triggered by an event, for example, a file upload. A target URL MUST be unique for each project — event type combination.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

uploadcare-webhook-api-openapi.yml Raw ↑

Other APIs Uploadcare publishes across the network.

Uploadcare Upload API
AE Profile APIs.io
Uploadcare Add-Ons API
AE Profile APIs.io
Uploadcare Conversion API
AE Profile APIs.io
Uploadcare File API
AE Profile APIs.io
Uploadcare File information API
AE Profile APIs.io
Uploadcare File metadata API
AE Profile APIs.io
Uploadcare File names API
AE Profile APIs.io
Uploadcare Group API
AE Profile APIs.io
Uploadcare Groups API
AE Profile APIs.io
Uploadcare Project API
AE Profile APIs.io
#Webhook
← Back to U APIs
API Details
ID
uploadcare:uploadcare-webhook-api
Base URL
https://api.uploadcare.com
Docs
https://uploadcare.com/api-refs/rest-api/v0.7.0/
Provider
Uploadcare
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network