> ## Documentation Index
> Fetch the complete documentation index at: https://apidocs.royalti.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Download status update webhook
> Receives status updates for download preparation operations from Google Cloud Functions.
This endpoint requires authentication. Include your Bearer token in the Authorization header.
## Description
**Authentication:** Requires `royalti-x-hash` header containing HMAC signature.
**Workflow:**
1. Validates download record exists
2. Updates download status and URL
3. Sends email notification when status is 'done'
## Code Examples
```javascript Node.js theme={null}
const response = await fetch('https://api.royalti.io/webhook/download/status-update/webhook', {
method: 'POST',
headers: {
'Authorization': `Bearer ${token}`,
'Content-Type': 'application/json'
},
body: JSON.stringify({
"id": "d3f2c1b0-1234-5678-90ab-cdef12345678",
"status": "done",
"url": "https://storage.googleapis.com/downloads/export-2024-01-15.csv?signature=..."
})
});
const data = await response.json();
console.log(data);
```
```python Python theme={null}
import requests
response = requests.post(
'https://api.royalti.io/webhook/download/status-update/webhook',
headers={
'Authorization': f'Bearer {token}'
},
json={"id":"d3f2c1b0-1234-5678-90ab-cdef12345678","status":"done","url":"https://storage.googleapis.com/downloads/export-2024-01-15.csv?signature=..."}
)
data = response.json()
print(data)
```
```bash cURL theme={null}
curl -X POST https://api.royalti.io/webhook/download/status-update/webhook \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"id":"d3f2c1b0-1234-5678-90ab-cdef12345678","status":"done","url":"https://storage.googleapis.com/downloads/export-2024-01-15.csv?signature=..."}'
```
## OpenAPI
````yaml post /webhook/download/status-update/webhook
openapi: 3.0.0
info:
title: Royalti.io API
description: "# Royalti API\r\n\r\nThis is the Royalti music royalty management platform API server.\r\n\r\n## Overview\r\n\r\nThe Royalti API provides comprehensive music royalty management services including:\r\n- Music publishing and writer management\r\n- Royalty processing and analytics\r\n- DDEX integration for music industry standards\r\n- File processing and pattern recognition\r\n- Payment processing and distribution\r\n\r\n## Authentication\r\n\r\nThe API uses JWT-based authentication with multiple protection levels:\r\n- Public endpoints for basic operations\r\n- Protected endpoints requiring valid JWT tokens\r\n- Admin endpoints for administrative functions\r\n\r\n## Features\r\n\r\n- Multi-dimensional royalty analytics\r\n- CWR (Collective Works Registration) support\r\n- DDEX integration for music metadata\r\n- Advanced file processing with pattern recognition\r\n- Real-time data processing with queue system"
version: 2.6.0
contact:
name: Royalti.io Support
email: support@royalti.io
url: https://royalti.io
license:
name: Proprietary
url: https://royalti.io/terms
servers:
- url: https://api.royalti.io
description: Production server
- url: https://api-dev.royalti.io
description: Development server
- url: http://localhost:8084
description: Local development
security:
- bearerAuth: []
tags:
- name: Accounting
description: Accounting and financial transaction operations
- name: DDEX
description: DDEX operations (ERN/MEAD, messages, delivery, providers)
- name: Label
description: Label management operations
- name: Internal Webhooks
description: Internal system webhooks for royalty processing and downloads
- name: Payment Webhooks
description: Payment processor webhook endpoints
- name: Billing Webhooks
description: Stripe billing and subscription webhooks
- name: Infrastructure Webhooks
description: Cloudflare domain and SSL webhooks
- name: Distribution Webhooks
description: Digital distribution platform webhooks (FUGA)
paths:
/webhook/download/status-update/webhook:
post:
tags:
- Internal Webhooks
summary: Download status update webhook
description: >-
Receives status updates for download preparation operations from Google
Cloud Functions.
**Authentication:** Requires `royalti-x-hash` header containing HMAC
signature.
**Workflow:**
1. Validates download record exists
2. Updates download status and URL
3. Sends email notification when status is 'done'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- id
- status
properties:
id:
type: string
format: uuid
description: Download record UUID
example: d3f2c1b0-1234-5678-90ab-cdef12345678
status:
type: string
enum:
- preparing
- done
- failed
- expired
description: Current status of the download
example: done
url:
type: string
format: uri
description: Google Cloud Storage signed URL for download
example: >-
https://storage.googleapis.com/downloads/export-2024-01-15.csv?signature=...
responses:
'200':
description: Webhook processed successfully
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: Download record status is marked as done
'400':
$ref: '#/components/responses/BadRequestError'
'401':
$ref: '#/components/responses/UnauthorizedError'
'404':
description: Download record not found
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: error
message:
type: string
example: Download Record not found
security:
- RoyaltiWebhookAuth: []
components:
responses:
BadRequestError:
description: Bad request - Invalid payload or validation error
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: error
message:
type: string
example: Invalid request data
UnauthorizedError:
description: Unauthorized - Invalid or missing authentication
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: error
message:
type: string
example: Invalid webhook signature
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: >-
JWT Authorization header using the Bearer scheme. Format: "Bearer
{token}"
````