Get a webhook by ID

Returns a single webhook by its unique identifier.

GET /environments/{environmentId}/webhooks/{webhookId}

Get a webhook by ID

cURL

curl --request GET \
  --url https://app.dynamicauth.com/api/v0/environments/{environmentId}/webhooks/{webhookId} \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://app.dynamicauth.com/api/v0/environments/{environmentId}/webhooks/{webhookId}")
  .header("Authorization", "Bearer <token>")
  .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::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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"

Query Parameters

includeSecret · boolean

Include secret in response

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