Update webhook

Developing

PUT

/projects/{proj_id}/webhooks/{webhookId}

Update a Specific webhook by ID for a project

📣 this endpoint update a specific webhook by webhook ID for a project . In this PUT request the project ID and webhook ID have to be provided in the URL. All the updated data for a webhook have to be provided in the payload

✳ list of URL parameters

project_id = 36 character in length

webhook_id = 36 character in length

✳ list of URL parameters

name = Updated webhook name

target_url = updated webhook url

event_type = updated event type

events = updated events

auth_type = updated header

auth_type_api_key_header_name = updated header name

auth_type_api_key_header_value = updated header value

secrets = updated secret value

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

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

proj_id

string

required

Example:

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

webhookId

string

required

Example:

355f9505-e8b6-41a3-a2e7-96dbb0d2a272

Body Params application/json

object {0}

Example

{
    "name": "Webhook2",
    "target_url": "http://example.com/webhook2",
    "description": "This is a sample webhook2",
    "event_type": "event2",
    "events": {
        "event1":"valuenew1",
        "event2": "valuenew1"
    },
    "auth_type": "header",
    "auth_type_api_key_header_name": "Authorization",
    "auth_type_api_key_header_value": "Bearer",
    "secrets": "secretnew"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'http://localhost:8080/v1/projects/f32a0116-fe11-454c-8e6a-5ff4101882e5/webhooks/355f9505-e8b6-41a3-a2e7-96dbb0d2a272' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Webhook2",
    "target_url": "http://example.com/webhook2",
    "description": "This is a sample webhook2",
    "event_type": "event2",
    "events": {
        "event1":"valuenew1",
        "event2": "valuenew1"
    },
    "auth_type": "header",
    "auth_type_api_key_header_name": "Authorization",
    "auth_type_api_key_header_value": "Bearer",
    "secrets": "secretnew"
}'

Responses

🟢200OK

application/json

Body

object {0}

Examples

SuccessSuccessSuccessSuccess

{"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

Modified at 2024-07-29 04:57:42

GET Webhook by ID

Delete web hook

Update webhook

Update a Specific webhook by ID for a project#

Request

Request samples

Responses

Update a Specific webhook by ID for a project