castomAPI
Odbierz klucz
POST /v1/zapier/hooks/subscribe 1 token Klucz API Zapier

Zarejestruj subskrypcję REST Hook Zapiera lub strony trzeciej dla…

Zarejestruj subskrypcję REST Hook Zapiera lub strony trzeciej dla powiadomień o zdarzeniach w czasie rzeczywistym Dostawa jest at-least-once. Housekeeping ponownie umieszcza w kolejce zawieszone dostawy, więc subskrybent może otrzymać duplikat i powinien…

POST

Żądanie

  • x-api-key: <your-api-key>
  • Content-Type: application/json

Odpowiedź 

{
  "createdAt": "2026-09-08T10:00:00Z",
  "event": "<event>",
  "message": "Hello from castomAPI.",
  "secret": "<secret>",
  "status": "success",
  "subscriptionId": "sub_112060",
  "targetUrl": "https://example.com/page",
  "tokensDeducted": 1
}
Odpowiedź poniżej to makieta zbudowana ze schematu endpointu — żadne żądanie nie opuszcza tej strony. Zmień treść, naciśnij Wyślij, zobacz kształt odpowiedzi. Uruchom naprawdę w panelu →

Co robi

Zarejestruj subskrypcję REST Hook Zapiera lub strony trzeciej dla powiadomień o zdarzeniach w czasie rzeczywistym Dostawa jest at-least-once. Housekeeping ponownie umieszcza w kolejce zawieszone dostawy, więc subskrybent może otrzymać duplikat i powinien deduplikować po nagłówku X-CastomAPI-Delivery-Id.

Żądanie

Treść

PoleTypWymaganeOpis
eventenumtakEvent topic trigger to subscribe to One of: balance.low, endpoint.error, job.completed, security.alert, usage.threshold, discord.interaction_received, twitch.stream.online, twitch.stream.offline….
metadataobjectnieOptional user context metadata to attach to the subscription
secretstringnieOptional custom HMAC signing secret to verify payload signatures
targetUrlstringtakURL where castomAPI will dispatch POST event webhooks

Przykładowe żądanie

{
  "event": "balance.low",
  "metadata": {},
  "secret": "<secret>",
  "targetUrl": "https://example.com/page"
}

Odpowiedź

PoleTypOpis
createdAtstring
eventstring
messagestring
secretstringThe HMAC signing secret for this subscription. Returned once at creation; store it to verify the X-CastomAPI-Signature header -- it cannot be retrieved later.
statusstring
subscriptionIdstring
targetUrlstring
tokensDeductedinteger

Przykładowa odpowiedź

{
  "createdAt": "2026-09-08T10:00:00Z",
  "event": "<event>",
  "message": "Hello from castomAPI.",
  "secret": "<secret>",
  "status": "success",
  "subscriptionId": "sub_112060",
  "targetUrl": "https://example.com/page",
  "tokensDeducted": 1
}

Błędy

Każdy błąd ma tę samą kopertę: status HTTP, kod maszynowy i jedno zdanie.

400Treść albo parametr nie przeszły walidacji. Tablica details wskazuje pole.
401Brak klucza, klucz cofnięty albo zły nagłówek. Wyślij x-api-key.
402Portfel nie pokrywa tego wywołania. Doładuj albo poczekaj na miesięczny przydział.
404Zasób nie istnieje albo nie jest Twój. Obie sytuacje odpowiadają identycznie i nic nie kosztują.
429Przekroczony limit na minutę dla Twojego planu. Odczekaj i ponów.
5xxUsługa nadrzędna odmówiła albo przekroczyła czas. Wywołanie nie jest rozliczane.

Kod

curl -X POST 'https://app.castomapi.com/v1/zapier/hooks/subscribe' \
  -H 'x-api-key: <your-api-key>' \
  -H 'Content-Type: application/json' \
  -d '{"event": "balance.low", "metadata": {}, "secret": "<secret>", "targetUrl": "https://example.com/page"}'
const res = await fetch('https://app.castomapi.com/v1/zapier/hooks/subscribe', {
  method: 'POST',
  headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
  body: JSON.stringify({"event": "balance.low", "metadata": {}, "secret": "<secret>", "targetUrl": "https://example.com/page"})
});
const data = await res.json();
console.log(data);
import { request } from 'node:https';

// Node 18+ has fetch built in
const res = await fetch('https://app.castomapi.com/v1/zapier/hooks/subscribe', {
  method: 'POST',
  headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
  body: JSON.stringify({"event": "balance.low", "metadata": {}, "secret": "<secret>", "targetUrl": "https://example.com/page"})
});
const data = await res.json();
console.log(data);
import requests

res = requests.post(
    'https://app.castomapi.com/v1/zapier/hooks/subscribe',
    headers={'x-api-key': '<your-api-key>'},
    json={"event": "balance.low", "metadata": {}, "secret": "<secret>", "targetUrl": "https://example.com/page"},
    timeout=30,
)
print(res.json())
<?php
$ch = curl_init('https://app.castomapi.com/v1/zapier/hooks/subscribe');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['x-api-key: <your-api-key>', 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS => json_encode(['event' => 'balance.low', 'metadata' => [], 'secret' => '<secret>', 'targetUrl' => 'https://example.com/page']),
]);
$data = json_decode(curl_exec($ch), true);
print_r($data);

Koszt i limity

Ta operacja kosztuje 1 token. Nieudane wywołanie nigdy nie jest rozliczane. Każde konto dostaje 1000 darmowych tokenów miesięcznie; opłacone saldo nie wygasa.

Limity żądań na minutę

Bez klucza10
Free60
Pro300
Enterprise1200

Dokumentacja → Cennik

Pytania

Ile kosztuje Zarejestruj subskrypcję REST Hook Zapiera lub strony trzeciej dla…?

1 token za udane wywołanie, pobierane z portfela po odpowiedzi. Nieudane wywołania są bezpłatne. Każde konto dostaje 1000 darmowych tokenów miesięcznie.

Jak się uwierzytelnić?

Wyślij klucz w nagłówku x-api-key. Jeden klucz obejmuje każdy rozliczany endpoint; niczego nie trzeba włączać osobno.

Czy mogę wysłać nagłówek Authorization: Bearer zamiast klucza?

Nie dla rozliczanego endpointu — te przyjmują wyłącznie nagłówek x-api-key. Tokeny Bearer należą do strony konta: panel i API konta przyjmują sesję JWT, a castomapi-auth wydaje je standardowym uzgodnieniem OAuth2, z grantami authorization code, client credentials i refresh. Opisuje to strona usługi auth.

Jakie są limity?

10 żądań na minutę z jednego IP zupełnie bez klucza, 60 na minutę w planie Free, 300 w Pro, 1200 w Enterprise. Powyżej poziomu bez klucza limit jest na konto, łącznie dla wszystkich endpointów.

OpenAPI: https://app.castomapi.com/docs/json