Update webhook

curl --request PATCH \
  --url https://spectrum.photon.codes/projects/{projectId}/webhooks/{webhookId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "schemaVersion": "raw-inbound.v1",
  "eventTypes": [
    "message.received"
  ],
  "enabled": true,
  "failureNotificationEmail": "[email protected]"
}
'

import requests

url = "https://spectrum.photon.codes/projects/{projectId}/webhooks/{webhookId}"

payload = {
    "schemaVersion": "raw-inbound.v1",
    "eventTypes": ["message.received"],
    "enabled": True,
    "failureNotificationEmail": "[email protected]"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    schemaVersion: 'raw-inbound.v1',
    eventTypes: ['message.received'],
    enabled: true,
    failureNotificationEmail: '[email protected]'
  })
};

fetch('https://spectrum.photon.codes/projects/{projectId}/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://spectrum.photon.codes/projects/{projectId}/webhooks/{webhookId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'schemaVersion' => 'raw-inbound.v1',
    'eventTypes' => [
        'message.received'
    ],
    'enabled' => true,
    'failureNotificationEmail' => '[email protected]'
  ]),
  CURLOPT_HTTPHEADER => [
    "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://spectrum.photon.codes/projects/{projectId}/webhooks/{webhookId}"

	payload := strings.NewReader("{\n  \"schemaVersion\": \"raw-inbound.v1\",\n  \"eventTypes\": [\n    \"message.received\"\n  ],\n  \"enabled\": true,\n  \"failureNotificationEmail\": \"[email protected]\"\n}")

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

	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.patch("https://spectrum.photon.codes/projects/{projectId}/webhooks/{webhookId}")
  .header("Content-Type", "application/json")
  .body("{\n  \"schemaVersion\": \"raw-inbound.v1\",\n  \"eventTypes\": [\n    \"message.received\"\n  ],\n  \"enabled\": true,\n  \"failureNotificationEmail\": \"[email protected]\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://spectrum.photon.codes/projects/{projectId}/webhooks/{webhookId}")

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

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"schemaVersion\": \"raw-inbound.v1\",\n  \"eventTypes\": [\n    \"message.received\"\n  ],\n  \"enabled\": true,\n  \"failureNotificationEmail\": \"[email protected]\"\n}"

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

{
  "succeed": true,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "webhookUrl": "<string>",
    "schemaVersion": "normalized-events.v1",
    "eventTypes": [
      "message.received"
    ],
    "enabled": true,
    "status": "active",
    "failureNotificationEmail": "[email protected]",
    "disabledAt": "2023-11-07T05:31:56Z",
    "disabledReason": "manual",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

webhooks

Update webhook

Updates event subscriptions, failure-notification email, enabled state, or permanently upgrades an endpoint from normalized-events.v1 to raw-inbound.v1. message.received is currently the supported event type.

Send a schema-version change separately from settings updates. The request body only accepts schemaVersion: "raw-inbound.v1"; downgrading to normalized-events.v1 is not supported.

Before upgrading, deploy the standardSigningSecret returned at registration. The update response does not reveal that one-time secret again.

The handoff enables the Fusor destination before disabling the legacy source. Delivery can therefore briefly overlap while the legacy source converges, but avoids a delivery gap.

Returns 404 if the webhook does not belong to the authenticated project and 409 if a concurrent migration supersedes this request. Returns 409 if schemaVersion is combined with another setting, or if eventTypes or enabled is sent for an endpoint still pinned to normalized-events.v1. Requests to downgrade an endpoint to normalized-events.v1 fail schema validation with 422.

Requires Authorization: Basic base64(projectId:projectSecret).

PATCH

projects

{projectId}

webhooks

{webhookId}

Update webhook

curl --request PATCH \
  --url https://spectrum.photon.codes/projects/{projectId}/webhooks/{webhookId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "schemaVersion": "raw-inbound.v1",
  "eventTypes": [
    "message.received"
  ],
  "enabled": true,
  "failureNotificationEmail": "[email protected]"
}
'

import requests

url = "https://spectrum.photon.codes/projects/{projectId}/webhooks/{webhookId}"

payload = {
    "schemaVersion": "raw-inbound.v1",
    "eventTypes": ["message.received"],
    "enabled": True,
    "failureNotificationEmail": "[email protected]"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    schemaVersion: 'raw-inbound.v1',
    eventTypes: ['message.received'],
    enabled: true,
    failureNotificationEmail: '[email protected]'
  })
};

fetch('https://spectrum.photon.codes/projects/{projectId}/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://spectrum.photon.codes/projects/{projectId}/webhooks/{webhookId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'schemaVersion' => 'raw-inbound.v1',
    'eventTypes' => [
        'message.received'
    ],
    'enabled' => true,
    'failureNotificationEmail' => '[email protected]'
  ]),
  CURLOPT_HTTPHEADER => [
    "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://spectrum.photon.codes/projects/{projectId}/webhooks/{webhookId}"

	payload := strings.NewReader("{\n  \"schemaVersion\": \"raw-inbound.v1\",\n  \"eventTypes\": [\n    \"message.received\"\n  ],\n  \"enabled\": true,\n  \"failureNotificationEmail\": \"[email protected]\"\n}")

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

	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.patch("https://spectrum.photon.codes/projects/{projectId}/webhooks/{webhookId}")
  .header("Content-Type", "application/json")
  .body("{\n  \"schemaVersion\": \"raw-inbound.v1\",\n  \"eventTypes\": [\n    \"message.received\"\n  ],\n  \"enabled\": true,\n  \"failureNotificationEmail\": \"[email protected]\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://spectrum.photon.codes/projects/{projectId}/webhooks/{webhookId}")

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

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"schemaVersion\": \"raw-inbound.v1\",\n  \"eventTypes\": [\n    \"message.received\"\n  ],\n  \"enabled\": true,\n  \"failureNotificationEmail\": \"[email protected]\"\n}"

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

{
  "succeed": true,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "webhookUrl": "<string>",
    "schemaVersion": "normalized-events.v1",
    "eventTypes": [
      "message.received"
    ],
    "enabled": true,
    "status": "active",
    "failureNotificationEmail": "[email protected]",
    "disabledAt": "2023-11-07T05:31:56Z",
    "disabledReason": "manual",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Path Parameters

webhookId

string<uuid>

required

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

projectId

string<uuid>

required

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

schemaVersion

string

Allowed value: "raw-inbound.v1"

eventTypes

enum<string>[]

Minimum array length: 1

Available options:

message.received

enabled

boolean

failureNotificationEmail

string<email> | null

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

Response

200 - application/json

Response for status 200

succeed

boolean

required

data

object

required

Show child attributes

⌘I

Getting Started

Dashboard API

Spectrum API

Update webhook

Path Parameters

Body

Response