Skip to main content
POST
Create an endpoint

Authorizations

Authorization
string
header
required

An API key from Settings → API keys, sent as Authorization: Bearer yk_live_…. Scopes: transfers:read, transfers:write, collections:read, collections:write, contacts:read, contacts:write, webhooks:read, webhooks:write. A write scope implies read of the same resource.

Body

application/json
url
string | null
required

https URL to POST events to. null makes a pull endpoint: read its events from GET /webhooks/{id}/events.

Maximum string length: 2000
events
enum<string>[]
required

Event types to receive. Collection events need a paid plan.

Required array length: 1 - 20 elements
Available options:
transfer.ready,
transfer.downloaded,
transfer.expiring,
transfer.expired,
collection.file_uploaded,
request.submitted
description
string

A note for yourself.

Maximum string length: 200

Response

The endpoint and its secret.

webhook
object
required
secret
string
required

The signing secret. Shown once; store it now.