Create webhook

POST

session

apps

{appID}

webhooks

Create webhook

curl --request POST \
  --url https://api.prelude.dev/v2/session/apps/{appID}/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://example.com/webhook",
  "verification_token": "my-secret-token",
  "events": []
}
'

import requests

url = "https://api.prelude.dev/v2/session/apps/{appID}/webhooks"

payload = {
    "url": "https://example.com/webhook",
    "verification_token": "my-secret-token",
    "events": []
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    url: 'https://example.com/webhook',
    verification_token: 'my-secret-token',
    events: []
  })
};

fetch('https://api.prelude.dev/v2/session/apps/{appID}/webhooks', 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://api.prelude.dev/v2/session/apps/{appID}/webhooks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => 'https://example.com/webhook',
    'verification_token' => 'my-secret-token',
    'events' => [
        
    ]
  ]),
  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://api.prelude.dev/v2/session/apps/{appID}/webhooks"

	payload := strings.NewReader("{\n  \"url\": \"https://example.com/webhook\",\n  \"verification_token\": \"my-secret-token\",\n  \"events\": []\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.prelude.dev/v2/session/apps/{appID}/webhooks")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"https://example.com/webhook\",\n  \"verification_token\": \"my-secret-token\",\n  \"events\": []\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.prelude.dev/v2/session/apps/{appID}/webhooks")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"https://example.com/webhook\",\n  \"verification_token\": \"my-secret-token\",\n  \"events\": []\n}"

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

{
  "webhook": {
    "id": "web_01jqebhswje1ka1z7ahr9rfsgt",
    "url": "https://example.com/webhook",
    "events": [
      "user.created"
    ],
    "active": true,
    "last_http_code": 200,
    "last_http_code_date": "2025-03-15T14:45:00Z",
    "created_at": "2025-03-15T10:30:00Z",
    "updated_at": "2025-03-15T12:00:00Z"
  }
}

{
  "code": "invalid_request",
  "status": "bad_request",
  "message": "The request body is invalid."
}

{
  "code": "session_disabled",
  "status": "forbidden",
  "message": "Session management is disabled for this application."
}

{
  "code": "app_not_found",
  "status": "not_found",
  "message": "The application was not found."
}

Authorizations

Authorization

string

header

required

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

Path Parameters

appID

string

required

The id of the app the request refers to. An application's unique identifier.

Examples:

"54e9ujn"

"fvua38g"

Body

application/json

url

string<uri>

required

Maximum string length: 2048

Example:

"https://example.com/webhook"

verification_token

string

required

Maximum string length: 100

Example:

"my-secret-token"

events

enum<string>[]

required

Available options:

user.created,

user.deleted,

user.profile.updated,

user.identifier.created,

user.identifier.deleted,

user.session.created,

user.session.revoked,

user.passkey.registered,

user.passkey.deleted,

user.passkey.assertion_failed,

migration.hook_failed,

step_up.hook_failed

Callbacks

POST

{$request.body#/url}eventReceived

Body

application/json

app_id

string

required

An application's unique identifier.

Examples:

"54e9ujn"

"fvua38g"

events

object[]

required

Show child attributes

Response

200

Event accepted

GET

{$request.body#/url}verificationEvent

Response

200 - application/json

Webhook validated

challenge

number

required

The challenge you received as a query parameter in the webhook request.

Example:

1234567890

Response

Created

webhook

object

required

Show child attributes

Create webhook

curl --request POST \
  --url https://api.prelude.dev/v2/session/apps/{appID}/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://example.com/webhook",
  "verification_token": "my-secret-token",
  "events": []
}
'

import requests

url = "https://api.prelude.dev/v2/session/apps/{appID}/webhooks"

payload = {
    "url": "https://example.com/webhook",
    "verification_token": "my-secret-token",
    "events": []
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    url: 'https://example.com/webhook',
    verification_token: 'my-secret-token',
    events: []
  })
};

fetch('https://api.prelude.dev/v2/session/apps/{appID}/webhooks', 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://api.prelude.dev/v2/session/apps/{appID}/webhooks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => 'https://example.com/webhook',
    'verification_token' => 'my-secret-token',
    'events' => [
        
    ]
  ]),
  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://api.prelude.dev/v2/session/apps/{appID}/webhooks"

	payload := strings.NewReader("{\n  \"url\": \"https://example.com/webhook\",\n  \"verification_token\": \"my-secret-token\",\n  \"events\": []\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.prelude.dev/v2/session/apps/{appID}/webhooks")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"https://example.com/webhook\",\n  \"verification_token\": \"my-secret-token\",\n  \"events\": []\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.prelude.dev/v2/session/apps/{appID}/webhooks")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"https://example.com/webhook\",\n  \"verification_token\": \"my-secret-token\",\n  \"events\": []\n}"

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

{
  "webhook": {
    "id": "web_01jqebhswje1ka1z7ahr9rfsgt",
    "url": "https://example.com/webhook",
    "events": [
      "user.created"
    ],
    "active": true,
    "last_http_code": 200,
    "last_http_code_date": "2025-03-15T14:45:00Z",
    "created_at": "2025-03-15T10:30:00Z",
    "updated_at": "2025-03-15T12:00:00Z"
  }
}

{
  "code": "invalid_request",
  "status": "bad_request",
  "message": "The request body is invalid."
}

{
  "code": "session_disabled",
  "status": "forbidden",
  "message": "Session management is disabled for this application."
}

{
  "code": "app_not_found",
  "status": "not_found",
  "message": "The application was not found."
}

Documentation

API Reference

Authorizations

Path Parameters

Body

Callbacks

Body

Response

Response

Response