create web hook

Developing

POST

/projects/{id}/webhooks

Create a Webhook for a project

📣 this endpoint Creates a Webhook for a project . In this POST request the project ID has to be provided .In the Request payload necessary data has to be provided

✳ list of URL parameters

project_id = 36 character in length

✳ list of JSON Payload

name = name of the webhook

parent_id = name of the parent collection

target_url = target url

description = description of webhook

event_type = event type

events = list of events

auth_type = type of auth

auth_type_api_key_header_name = header name

auth_type_api_key_header_value = header value

secrets = secret value

📢 Info message : Here URL is contructed like
POST /projects/<project_id>/webhooks

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

string

required

Example:

f32a0116-fe11-454c-8e6a-5ff4101882e5

Body Params application/json

object {0}

Example

{
    "project_id": "f32a0116-fe11-454c-8e6a-5ff4101882e5",
    "name": "Webhook1",
    "target_url": "http://example.com/webhook",
    "description": "This is a sample webhook",
    "event_type": "event1",
    "events": ["video.created", "video.deleted"],
    "auth_type": "header",
    "auth_type_api_key_header_name": "Authorization",
    "auth_type_api_key_header_value": "Bearer",
    "secrets": "secret1"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://localhost:8080/v1/projects/f32a0116-fe11-454c-8e6a-5ff4101882e5/webhooks' \
--header 'Content-Type: application/json' \
--data-raw '{
    "project_id": "f32a0116-fe11-454c-8e6a-5ff4101882e5",
    "name": "Webhook1",
    "target_url": "http://example.com/webhook",
    "description": "This is a sample webhook",
    "event_type": "event1",
    "events": ["video.created", "video.deleted"],
    "auth_type": "header",
    "auth_type_api_key_header_name": "Authorization",
    "auth_type_api_key_header_value": "Bearer",
    "secrets": "secret1"
}'

Responses

🟢200OK

application/json

Body

object {0}

Examples

SuccessSuccess

{"message":"Webhook Created","result":{"id":"97a7e1e4-dc3a-4d6d-8fd5-3034fbc26067","project_id":"19a2c7db-f22f-4871-9ab7-e9df1021d100","name":"Webhook1","target_url":"http://example.com/webhook","description":"This is a sample webhook","event_type":"event1","events":{"event1":"value1","event2":"value2"},"auth_type":"header","auth_type_api_key_header_name":"Authorization","auth_type_api_key_header_value":"Bearer","secrets":"secret1","created_at":"2024-02-19T12:39:20.319811191Z","updated_at":"2024-02-19T12:39:20.319811241Z","deleted_at":null},"success":true}

🟢200OK

Get webhook

GET Webhook by ID

create web hook

Create a Webhook for a project#

Request

Request samples

Responses

Create a Webhook for a project