ارسال دوباره‌ی یک رویداد

POST/v1/webhooks/replay

یک رویداد را با همان بدنه و همان امضا دوباره می‌فرستد و یک دور تازه‌ی 8 تلاشی شروع می‌کند.

دسترسی لازم

read

سقف نرخ در دقیقه

60 برای هر سازمان

درخواست

curl

curl -X POST 'https://api.romu.ir/v1/webhooks/replay' \
  -H "X-Custody-Key-Id: $KEY_ID" \
  -H "X-Custody-Timestamp: $TIMESTAMP" \
  -H "X-Custody-Nonce: $NONCE" \
  -H "X-Custody-Signature: $SIGNATURE" \
  -H "Content-Type: application/json" \
  -d '{
    "event_id": "0192f1a4-2b6d-7e01-8f3a-9c4d5e6f7a81"
  }'

TypeScript

import { romu } from "./romu.ts";

const res = await romu.post("/v1/webhooks/replay", {
  json: {
    "event_id": "0192f1a4-2b6d-7e01-8f3a-9c4d5e6f7a81"
  },
});
console.log(res.status, res.body);

Go

status, body, err := client.Do("POST", "/v1/webhooks/replay", "", []byte(`{"event_id":"0192f1a4-2b6d-7e01-8f3a-9c4d5e6f7a81"}`), "")

Python

import romu

status, body = romu.post(
    "/v1/webhooks/replay",
    json={
      "event_id": "0192f1a4-2b6d-7e01-8f3a-9c4d5e6f7a81"
    },
)
print(status, body)

امضای درخواست را کتابخانه انجام می‌دهد؛ جزئیات: صفحه‌ی امضا

بدنه

event_idUUIDلازم

فیلد ناشناخته در بدنه 400 می‌گیرد.

پاسخ

200ارسال در صف قرار گرفت.

فیلدها

deliveryobjectلازم

delivery.event_idstring

delivery.tx_idstring

delivery.kindstring

delivery.statusstring

pendingdeliveredskippedfailed

delivery.attemptinteger

delivery.next_retry_atRFC 3339

delivery.created_atRFC 3339

delivery.updated_atRFC 3339

خطاها

400invalid request یا malformed request body⁠: بدنه، پارامتر یا فیلد نادرست است، یا فیلد ناشناخته دارد.

401unauthenticated⁠: هر شکست احراز هویت همین پاسخ را دارد.

403permission denied⁠: کلید دسترسی این مسیر را ندارد.

404not found⁠: مسیر یا شیء پیدا نشد. خواندن کیف پولی بیرون از فهرست کلید هم همین است.

409Webhook خاموش است (the organisation's webhook is off⁠)، رویداد هنوز در صف ارسال است، یا نوع رویداد انتخاب نشده است.

429too many requests⁠: بیش از سقف نرخ. پس از Retry-After ثانیه دوباره بفرستید.

503try again later⁠: سرویس موقتاً در دسترس نیست.

بدنه‌ی خطا همیشه {"error":"..."} است. راهنمای خطاها می‌گوید برای هر کد چه باید کرد.