Platform Integration API Reference CLI Benchmarks

Webhooks

Get a single webhook

Retrieve details of a specific webhook configuration by its ID. The webhook must belong to the current project.

GET

/api/webhooks/{webhookId}

Authorization

Authorization

header

string

required

Enter the project access token with the Bearer prefix, e.g. "Bearer project_access_token"

Path Parameters

webhookId

string

required

Webhook ID

Responses

application/json

data

object

required

Data contains the response object

status

"success"

string

required

Status indicates the response status "success"

Success response with webhook details

application/json

error

object

required

Error response details

status

"error"

string

required

Status indicates the response status "error"

Authentication error: invalid token or subscription inactive

application/json

error

object

required

Error response details

status

"error"

string

required

Status indicates the response status "error"

Resource not found

application/json

error

object

required

Error response details

status

"error"

string

required

Status indicates the response status "error"

Rate limit exceeded

import Chunkify from '@chunkify/chunkify';

const client = new Chunkify({
  projectAccessToken: 'My Project Access Token',
});

const webhook = await client.webhooks.retrieve('webhookId');

console.log(webhook);
from chunkify import Chunkify

client = Chunkify(
    project_access_token="My Project Access Token",
)
webhook = client.webhooks.retrieve(
    "webhookId",
)
print(webhook)
<?php

use Chunkify\Client;

$client = new Client(
    projectAccessToken: 'My Project Access Token',
);

$webhook = $client->webhooks->retrieve('webhookId');

var_dump($webhook);
package main

import (
  "context"
  "fmt"

  "github.com/chunkifydev/chunkify-go"
  "github.com/chunkifydev/chunkify-go/option"
)

func main() {
  client := chunkify.NewClient(
    option.WithProjectAccessToken("My Project Access Token"),
  )
  webhook, err := client.Webhooks.Get(context.TODO(), "webhookId")
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", webhook)
}

{
  "data": {
    "enabled": true,
    "events": [
      "job.completed",
      "job.failed"
    ],
    "id": "wh_2G6MJiNz71bHQGNzGwKx5cJwPFS",
    "project_id": "proj_2G6MJiNz71bHQGNzGwKx5cJwPFS",
    "url": "https://example.com/webhook"
  },
  "status": "success"
}
{
  "error": {
    "code": 401,
    "message": "Authentication error: invalid token or subscription inactive",
    "type": "AuthenticationError"
  },
  "status": "error"
}
{
  "error": {
    "code": 404,
    "message": "Ressource not found",
    "type": "NotFoundError"
  },
  "status": "error"
}
{
  "error": {
    "code": 429,
    "message": "Rate limit exceeded",
    "type": "TooManyRequestsError"
  },
  "status": "error"
}

# Get a single webhook > Retrieve details of a specific webhook configuration by its ID. The webhook must belong to the current project. ```json { "path": "/api/webhooks/{webhookId}", "method": "get", "schema": { "description": "Retrieve details of a specific webhook configuration by its ID. The webhook must belong to the current project.", "operationId": "getWebhook", "parameters": [ { "description": "Webhook ID", "in": "path", "name": "webhookId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookResponse" } } }, "description": "Success response with webhook details" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorAuthentication" } } }, "description": "Authentication error: invalid token or subscription inactive" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorNotFound" } } }, "description": "Resource not found" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorTooManyRequests" } } }, "description": "Rate limit exceeded" } }, "security": [ { "ProjectAccessToken": [] } ], "summary": "Get a single webhook", "tags": [ "Webhooks" ], "x-codeSamples": [ { "lang": "JavaScript", "source": "import Chunkify from '@chunkify/chunkify';\n\nconst client = new Chunkify({\n projectAccessToken: 'My Project Access Token',\n});\n\nconst webhook = await client.webhooks.retrieve('webhookId');\n\nconsole.log(webhook);" }, { "lang": "Python", "source": "from chunkify import Chunkify\n\nclient = Chunkify(\n project_access_token=\"My Project Access Token\",\n)\nwebhook = client.webhooks.retrieve(\n \"webhookId\",\n)\nprint(webhook)" }, { "lang": "php", "source": "\u003c?php\n\nuse Chunkify\\Client;\n\n$client = new Client(\n projectAccessToken: 'My Project Access Token',\n);\n\n$webhook = $client-\u003ewebhooks-\u003eretrieve('webhookId');\n\nvar_dump($webhook);" }, { "lang": "Go", "source": "package main\n\nimport (\n \"context\"\n \"fmt\"\n\n \"github.com/chunkifydev/chunkify-go\"\n \"github.com/chunkifydev/chunkify-go/option\"\n)\n\nfunc main() {\n client := chunkify.NewClient(\n option.WithProjectAccessToken(\"My Project Access Token\"),\n )\n webhook, err := client.Webhooks.Get(context.TODO(), \"webhookId\")\n if err != nil {\n panic(err.Error())\n }\n fmt.Printf(\"%+v\\n\", webhook)\n}\n" } ] } } ``` ```json #/components/schemas/WebhookResponse { "properties": { "data": { "$ref": "#/components/schemas/Webhook", "description": "Data contains the response object" }, "status": { "const": "success", "description": "Status indicates the response status \"success\"", "type": "string" } }, "required": [ "status", "data" ], "type": "object" } ``` ```json #/components/schemas/Webhook { "properties": { "enabled": { "description": "Whether the webhook is currently enabled", "examples": [ true ], "type": "boolean" }, "events": { "description": "Array of event types this webhook subscribes to", "examples": [ [ "job.completed", "job.failed" ] ], "items": { "$ref": "#/components/schemas/WebhookEvent" }, "type": "array" }, "id": { "description": "Unique identifier of the webhook", "examples": [ "wh_2G6MJiNz71bHQGNzGwKx5cJwPFS" ], "type": "string" }, "project_id": { "description": "ID of the project this webhook belongs to", "examples": [ "proj_2G6MJiNz71bHQGNzGwKx5cJwPFS" ], "type": "string" }, "url": { "description": "URL where webhook events will be sent", "examples": [ "https://example.com/webhook" ], "type": "string" } }, "required": [ "enabled", "events", "id", "project_id", "url" ], "type": "object" } ``` ```json #/components/schemas/WebhookEvent { "enum": [ "job.completed", "job.failed", "job.cancelled", "upload.completed", "upload.failed", "upload.expired" ], "type": "string" } ``` ```json #/components/schemas/ResponseErrorAuthentication { "description": "Error response", "properties": { "error": { "description": "Error response details", "properties": { "code": { "const": 401, "description": "Code is the HTTP status code", "examples": [ 401 ], "type": "integer" }, "message": { "description": "Message is a human-readable error description", "examples": [ "Authentication error: invalid token or subscription inactive" ], "type": "string" }, "type": { "const": "AuthenticationError", "description": "Type indicates the error category", "enum": [ "AuthenticationError" ], "type": "string" } }, "required": [ "type", "code", "message" ], "type": "object" }, "status": { "const": "error", "description": "Status indicates the response status \"error\"", "type": "string" } }, "required": [ "status", "error" ], "type": "object" } ``` ```json #/components/schemas/ResponseErrorNotFound { "description": "Error response", "properties": { "error": { "description": "Error response details", "properties": { "code": { "const": 404, "description": "Code is the HTTP status code", "examples": [ 404 ], "type": "integer" }, "message": { "description": "Message is a human-readable error description", "examples": [ "Ressource not found" ], "type": "string" }, "type": { "const": "NotFoundError", "description": "Type indicates the error category", "enum": [ "NotFoundError" ], "type": "string" } }, "required": [ "type", "code", "message" ], "type": "object" }, "status": { "const": "error", "description": "Status indicates the response status \"error\"", "type": "string" } }, "required": [ "status", "error" ], "type": "object" } ``` ```json #/components/schemas/ResponseErrorTooManyRequests { "description": "Error response", "properties": { "error": { "description": "Error response details", "properties": { "code": { "const": 429, "description": "Code is the HTTP status code", "examples": [ 429 ], "type": "integer" }, "message": { "description": "Message is a human-readable error description", "examples": [ "Rate limit exceeded" ], "type": "string" }, "type": { "const": "TooManyRequestsError", "description": "Type indicates the error category", "enum": [ "TooManyRequestsError" ], "type": "string" } }, "required": [ "type", "code", "message" ], "type": "object" }, "status": { "const": "error", "description": "Status indicates the response status \"error\"", "type": "string" } }, "required": [ "status", "error" ], "type": "object" } ```