notifications

POST `/v1/notification-connections/{connection_id}/verify`

Send a real test message to a destination.

การยืนยันตัวตน

ส่ง API key เป็น bearer token เอนด์พอยต์นี้ไม่ได้ระบุสิทธิ์การใช้งานเฉพาะในข้อกำหนด ดังนั้นควรให้คีย์ของคุณมีสิทธิ์น้อยที่สุดเท่าที่จำเป็นและให้ตรวจสอบจากการตอบกลับแทนที่จะคาดเดา

ตำแหน่งสำหรับใส่รหัสองค์กรของคุณ

พอยต์ข้อมูลนี้รับ org_id เป็นพารามิเตอร์คิวรี หากเว้นว่างไว้ การเรียกใช้งานจะครอบคลุมย่อยของเทแนนท์ทั้งหมดของคุณ แต่หากระบุค่า จะช่วยจำกัดขอบเขตการเรียกให้เหลือเพียงองค์กรเดียว

รหัสองค์กรของคุณจะแสดงอยู่บนหน้าคีย์ API ในแดชบอร์ดของคุณ โดยอยู่ถัดจากคีย์นั้นๆ รหัสนี้จะเป็นรหัสเดิมในการเรียกใช้งานทุกครั้งของคุณ

ทดลองใช้เลย

แทนที่สิ่งใดๆ ที่อยู่ภายในวงเล็บแหลมด้วยค่าของคุณเอง และตัวยึดตำแหน่งคีย์ด้วยคีย์จากแดชบอร์ดของคุณ

curl -X POST https://api.zinndigital.com/v1/notification-connections/{connection_id}/verify \
  -H "Authorization: Bearer zdk_live_…"

เข้าสู่ระบบแล้วใช่ไหม คอนโซล API ในแดชบอร์ดของคุณจะเติมรหัสองค์กรจริงและคีย์ของคุณเองโดยอัตโนมัติ และทำการส่งคำขอไปยัง API จริง เพื่อให้คุณเห็นผลลัพธ์ที่เป็นข้อมูลจริง เปิดจุดสิ้นสุดนี้ในคอนโซล API

รายละเอียด

Sends an actual message and records what happened. It does not check that the destination looks plausible; nothing may be routed to a connection until this has succeeded.

พารามิเตอร์

ชื่อ	ประเภท	จำเป็นต้องมี	ลักษณะของสิ่งนี้
`connection_id (path)`	`string`	ใช่	—
`org_id (query)`	`string`	ไม่ใช่	The organization to act on. Omitted resolves to your own ONLY when you belong to exactly one organisation; a principal in more than one must name it, or the call is refused `422…

การตอบกลับ

ชื่อ	ประเภท	จำเป็นต้องมี	ลักษณะของสิ่งนี้
`verified`	`boolean`	ไม่ใช่	—
`awaiting_confirmation`	`boolean`	ไม่ใช่	An e-mail destination has been sent its confirmation link and is waiting for the recipient to click it. Not verified, and not a failure.
`unknown`	`boolean`	ไม่ใช่	⛔⛔ We could not CHECK - which is not the same as it failed, and until W39-AM this response could not say the difference. Both were `verified: false`, so a credential-store bli…
`error`	`string`	ไม่ใช่	Safe to display - never contains a credential.