Add webhook

POST

/v1/users/webhook

📡 Webhook API (File Process Notification)

Clients can register a webhook endpoint to receive automatic notifications when a file has been processed by Snapbyte.

Once processing is complete, Snapbyte will send a POST request to your webhook URL with the following JSON payload:

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "done",
}

or

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "error",
}

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.snapbyte.io/v1/users/webhook' \
--header 'Content-Type: application/json' \
--header 'x-api-key;' \
--data-raw '{
    "webhook": "string"
}'

Response Example

{ 
    "success": true,
    "message": "Updated",
    "data": {}
}

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Body Params application/json

webhook

string

required

Webhook Url

Examples

Responses

🟢200Success

application/json

Body

object {0}

Modified at 2025-07-13 02:00:26

Get API Key

Get User Stats

Add webhook

📡 Webhook API (File Process Notification)#

Request

Responses

📡 Webhook API (File Process Notification)