Settings

Written for: ＋ Written for
Deprecated: ＋ Deprecated
Applies to: ＋ Applies to

AdminUpdated Sep 24, 2026

POSThttps://shippified.net/api/settings

Update workspace intake settings.

Partial update — omitted fields keep their values. `outputWebhook` is the fallback webhook every newly parsed order is re-posted to when its bot has no output webhook of its own; `updatesWebhook` receives shipped / delivered / updated events. Both must be public URLs (private and internal addresses are refused). When `forwardOn` is sent, any flag left out is set to `true`. Daily-digest settings live at `PATCH /api/discord/settings`.

Request body application/json

{
  "outputWebhook": "string",
  "updatesWebhook": "string",
  "forwardOn": {
    "placed": true,
    "shipped": true,
    "delivered": true,
    "updated": true
  }
}

Responses

200 Updated. Returns the full workspace snapshot (same shape as `GET /api/state`).

{}

400 A webhook URL was refused, e.g. it points at a private address.

{
  "error": "string"
}

401 Not authenticated.

Code samples

cURL

curl -X POST "https://shippified.net/api/settings" \
  -H "Content-Type: application/json" \
  -d '{"outputWebhook":"string","updatesWebhook":"string","forwardOn":{"placed":true,"shipped":true,"delivered":true,"updated":true}}'

TypeScript

const res = await fetch('https://shippified.net/api/settings', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"outputWebhook":"string","updatesWebhook":"string","forwardOn":{"placed":true,"shipped":true,"delivered":true,"updated":true}}),
});
const data = await res.json();

Python

import requests

res = requests.request(
    "POST",
    "https://shippified.net/api/settings",
    headers={
    "Content-Type": "application/json",
    },
    json={"outputWebhook": "string", "updatesWebhook": "string", "forwardOn": {"placed": True, "shipped": True, "delivered": True, "updated": True}},
)
data = res.json()

package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://shippified.net/api/settings", strings.NewReader(`{"outputWebhook":"string","updatesWebhook":"string","forwardOn":{"placed":true,"shipped":true,"delivered":true,"updated":true}}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}

PHP

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://shippified.net/api/settings');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"outputWebhook":"string","updatesWebhook":"string","forwardOn":{"placed":true,"shipped":true,"delivered":true,"updated":true}}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Ruby

require 'net/http'
require 'uri'

uri = URI('https://shippified.net/api/settings')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"outputWebhook":"string","updatesWebhook":"string","forwardOn":{"placed":true,"shipped":true,"delivered":true,"updated":true}}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body

Java

import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://shippified.net/api/settings"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"outputWebhook\":\"string\",\"updatesWebhook\":\"string\",\"forwardOn\":{\"placed\":true,\"shipped\":true,\"delivered\":true,\"updated\":true}}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Was this page helpful?