Update a webhook by ID

Updates the specified webhook.

PUT /environments/{environmentId}/webhooks/{webhookId}

Update a webhook by ID

cURL

curl --request PUT \
  --url https://app.dynamicauth.com/api/v0/environments/{environmentId}/webhooks/{webhookId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://website-sample.com",
  "isEnabled": true,
  "events": [
    "<string>"
  ]
}
'

import requests

url = "https://app.dynamicauth.com/api/v0/environments/{environmentId}/webhooks/{webhookId}"

payload = {
    "url": "https://website-sample.com",
    "isEnabled": True,
    "events": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({url: 'https://website-sample.com', isEnabled: true, events: ['<string>']})
};

fetch('https://app.dynamicauth.com/api/v0/environments/{environmentId}/webhooks/{webhookId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.dynamicauth.com/api/v0/environments/{environmentId}/webhooks/{webhookId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => 'https://website-sample.com',
    'isEnabled' => true,
    'events' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.dynamicauth.com/api/v0/environments/{environmentId}/webhooks/{webhookId}"

	payload := strings.NewReader("{\n  \"url\": \"https://website-sample.com\",\n  \"isEnabled\": true,\n  \"events\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://app.dynamicauth.com/api/v0/environments/{environmentId}/webhooks/{webhookId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"https://website-sample.com\",\n  \"isEnabled\": true,\n  \"events\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.dynamicauth.com/api/v0/environments/{environmentId}/webhooks/{webhookId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"https://website-sample.com\",\n  \"isEnabled\": true,\n  \"events\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

200

{
  "environmentId": "95b11417-f18f-457f-8804-68e361f9164f",
  "webhookId": "95b11417-f18f-457f-8804-68e361f9164f",
  "url": "https://website-sample.com",
  "events": [
    "<string>"
  ],
  "isEnabled": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "secret": "<string>",
  "version": "<string>",
  "enabledAt": "2023-11-07T05:31:56Z"
}

{
  "error": "No jwt provided!"
}

{
  "error": "Access Forbidden"
}

{
  "error": "Internal Server Error"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

environmentId · string · required

ID of the environment

Required string length: 36

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

webhookId · string · required

UUID of the webhook

Required string length: 36

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

Body

application/json

url · string · required

Pattern: ^(https:\/\/)[a-z0-9]+([-.]+[a-z0-9]+)*\.[a-z]{2,10}(\/.*)?$|^arn:aws:sns:[a-z0-9-]*:[0-9]{12}:[a-zA-Z0-9-_]+$

Example:

"https://website-sample.com"

isEnabled · boolean · required

When true the webhook delivers events; when false events are silently skipped

events · string[] · required

Array of subscribed event type names (e.g. "admin.user.created", "admin.webhook.updated")

Response

200

application/json

Webhook for this project environment

environmentId · string · required

Required string length: 36

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

webhookId · string · required

Required string length: 36

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

url · string · required

Pattern: ^(https:\/\/)[a-z0-9]+([-.]+[a-z0-9]+)*\.[a-z]{2,10}(\/.*)?$|^arn:aws:sns:[a-z0-9-]*:[0-9]{12}:[a-zA-Z0-9-_]+$

Example:

"https://website-sample.com"

events · string[] · required

List of subscribed event type names (e.g. "admin.user.created")

isEnabled · boolean · required

Whether the webhook is actively delivering events

createdAt · string<date-time> · required

ISO 8601 timestamp of when the webhook was created

updatedAt · string<date-time> · required

ISO 8601 timestamp of when the webhook was last updated

secret · string

HMAC signing secret used to verify webhook payload authenticity

version · string

Webhook payload format version

enabledAt · string<date-time>

ISO 8601 timestamp of when the webhook was last enabled