Create Webhook Endpoint

Register a URL that receives signed alert event POSTs

POST /v1/webhooks

Create Webhook Endpoint

cURL

curl --request POST \
  --url https://api.signa.so/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "description": "<string>",
  "enabled_events": [
    "<string>"
  ],
  "metadata": {}
}
'

import requests

url = "https://api.signa.so/v1/webhooks"

payload = {
    "url": "<string>",
    "description": "<string>",
    "enabled_events": ["<string>"],
    "metadata": {}
}
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: '<string>',
    description: '<string>',
    enabled_events: ['<string>'],
    metadata: {}
  })
};

fetch('https://api.signa.so/v1/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.signa.so/v1/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' => '<string>',
    'description' => '<string>',
    'enabled_events' => [
        '<string>'
    ],
    'metadata' => [
        
    ]
  ]),
  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.signa.so/v1/webhooks"

	payload := strings.NewReader("{\n  \"url\": \"<string>\",\n  \"description\": \"<string>\",\n  \"enabled_events\": [\n    \"<string>\"\n  ],\n  \"metadata\": {}\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.signa.so/v1/webhooks")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"<string>\",\n  \"description\": \"<string>\",\n  \"enabled_events\": [\n    \"<string>\"\n  ],\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.signa.so/v1/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\": \"<string>\",\n  \"description\": \"<string>\",\n  \"enabled_events\": [\n    \"<string>\"\n  ],\n  \"metadata\": {}\n}"

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

{
  "id": "whk_2mR8vNkT",
  "object": "webhook_endpoint",
  "url": "https://hooks.auroradigital.example.com/signa",
  "description": "Production alerts for Aurora Digital",
  "enabled_events": ["alert.created"],
  "status": "active",
  "secret_version": 1,
  "secret": "whsec_8f2a1c9e4b7d0a3f6c5e2b1d9a8f7e6c",
  "consecutive_failures": 0,
  "last_success_at": null,
  "last_failure_at": null,
  "metadata": {},
  "created_at": "2026-07-06T08:00:00.000Z",
  "updated_at": "2026-07-06T08:00:00.000Z",
  "request_id": "req_4tYpL2Qn"
}

Overview

Registers a webhook endpoint and returns the signing secret once in the response. Store it immediately: list and retrieve responses redact it. A newly created endpoint’s status is always active.

Requires the portfolios:manage scope.

Body Parameters

url · string · required

HTTPS endpoint (HTTP is allowed in non-production environments only). Max 2048 chars.

description · string

Optional human-readable description (max 2000 chars).

enabled_events · string[] · required

1-20 event types. The only customer-subscribable event today is alert.created; any other value returns 400. webhook.test is delivered only when you call Test Webhook Endpoint; you can’t subscribe to it.

metadata · object

Free-form metadata.

Response

id · string

Endpoint ID (whk_*).

object · string

Always "webhook_endpoint".

url · string

Echo of input.

description · string | null

Echo of input.

enabled_events · string[]

Echo of input.

status · string

Always "active" on create.

secret_version · integer

Starts at 1.

secret · string

Plaintext signing secret. Returned only on this response and on rotate-secret.

consecutive_failures · integer

0 on create.

last_success_at · string | null

Null on create.

last_failure_at · string | null

Null on create.

metadata · object

Echoed back.

created_at · string

ISO timestamp.

updated_at · string

ISO timestamp.

request_id · string

Request identifier.

Errors

Status	type	When
400	validation_error	Invalid URL, unknown event type in enabled_events, or an HTTP URL in production

Code Examples

cURL

curl -X POST "https://api.signa.so/v1/webhooks" \
  -H "Authorization: Bearer sig_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: create-prod-webhook-2026-06-12" \
  -d '{
    "url": "https://hooks.auroradigital.example.com/signa",
    "description": "Production alerts for Aurora Digital",
    "enabled_events": ["alert.created"]
  }'

import { Signa } from "@signa-so/sdk";
const signa = new Signa({ api_key: process.env.SIGNA_API_KEY });

const wh = await signa.webhooks.create({
  url: "https://hooks.auroradigital.example.com/signa",
  description: "Production alerts for Aurora Digital",
  enabled_events: ["alert.created"],
});
// Store wh.secret in your secrets manager now: it is not returned again.
console.log(wh.secret);

{
  "id": "whk_2mR8vNkT",
  "object": "webhook_endpoint",
  "url": "https://hooks.auroradigital.example.com/signa",
  "description": "Production alerts for Aurora Digital",
  "enabled_events": ["alert.created"],
  "status": "active",
  "secret_version": 1,
  "secret": "whsec_8f2a1c9e4b7d0a3f6c5e2b1d9a8f7e6c",
  "consecutive_failures": 0,
  "last_success_at": null,
  "last_failure_at": null,
  "metadata": {},
  "created_at": "2026-07-06T08:00:00.000Z",
  "updated_at": "2026-07-06T08:00:00.000Z",
  "request_id": "req_4tYpL2Qn"
}

Related Endpoints

• Test Webhook Endpoint - send a synthetic ping before you go live
• Rotate Webhook Secret - roll the signing secret
• List Webhook Endpoints - list your endpoints
• Webhooks guide - signature verification and delivery behavior