تخطٍّ إلى المحتوى

مرجع PushWard API

المرجع الكامل لواجهة REST الخاصة بـ API الأنشطة المباشرة في iOS من PushWard وللإشعارات وعناصر الواجهة. استكشف كل نقطة نهاية أدناه، أو اقرأ دليل الواجهة البرمجية للمصادقة وأمثلة مشروحة.

نقاط النهاية

جميع المسارات نسبية إلى https://api.pushward.app

Activities

  • GET /activities List activities
  • POST /activities Create activity
  • GET /activities/{slug} Get activity
  • PATCH /activities/{slug} Update activity
  • DELETE /activities/{slug} Delete activity

Permissions

  • GET /activities/{slug}/permissions List permissions on activity
  • POST /activities/{slug}/permissions Grant permission on activity
  • GET /permissions List permissions
  • PATCH /permissions/{id} Update permission role
  • DELETE /permissions/{id} Revoke or leave permission
  • POST /permissions/patterns Grant permission on slug pattern

System

  • GET /app/onboarding Get onboarding state
  • PATCH /app/onboarding Update onboarding state
  • GET /health Health check بدون مصادقة

Auth

  • GET /auth/me Get current user profile
  • PATCH /auth/me Update current user profile

Devices

  • GET /devices List devices
  • GET /devices/{device_id} Get device
  • PATCH /devices/{device_id} Rename device
  • DELETE /devices/{device_id} Remove device
  • GET /devices/{device_id}/subscriptions List device subscriptions
  • GET /devices/{device_id}/subscriptions/{slug} Get device subscription status
  • POST /devices/{device_id}/subscriptions/{slug} Subscribe device to activity
  • DELETE /devices/{device_id}/subscriptions/{slug} Unsubscribe device from activity

Email

  • POST /emails Send transactional email
  • GET /emails/recipients List email recipients
  • POST /emails/recipients Register email recipient
  • DELETE /emails/recipients/{id} Delete email recipient
  • POST /emails/recipients/{id}/resend Resend recipient confirmation

Integration Keys

  • GET /integrations/keys List integration keys
  • POST /integrations/keys Create integration key
  • PATCH /integrations/keys/{key_id} Update integration key
  • DELETE /integrations/keys/{key_id} Revoke integration key
  • POST /integrations/keys/{key_id}/roll Roll integration key

Notifications

  • POST /notifications Create notification
  • GET /notifications/answers Stream notification answers
  • GET /notifications/answers/{id} Get notification answer
  • GET /notifications/receipts/{id} Get notification receipt
  • POST /notifications/receipts/{id}/cancel Cancel notification receipt
  • POST /notifications/receipts/cancel Cancel notification receipts by tag
  • POST /notifications/retract Retract notifications by collapse_id
  • GET /notifications/scheduled List scheduled notifications
  • POST /notifications/scheduled Schedule notification
  • GET /notifications/scheduled/{id} Get scheduled notification
  • DELETE /notifications/scheduled/{id} Cancel scheduled notification

Organizations

  • GET /orgs List my organizations
  • GET /orgs/{org_id} Get an organization
  • PATCH /orgs/{org_id} Rename an organization
  • GET /orgs/{org_id}/audit-events Organization audit log
  • GET /orgs/{org_id}/audit-events/export Export the organization audit log
  • GET /orgs/{org_id}/billing Get an organization's plan and billing
  • GET /orgs/{org_id}/billing/invoices List the plan's paid invoices
  • GET /orgs/{org_id}/billing/invoices/{transaction_id}/pdf Get a link to an invoice PDF
  • GET /orgs/{org_id}/devices List the members' devices
  • GET /orgs/{org_id}/domains List the organization's email domains
  • POST /orgs/{org_id}/domains Add an email domain
  • DELETE /orgs/{org_id}/domains/{domain_id} Remove an email domain
  • POST /orgs/{org_id}/domains/{domain_id}/verify Verify an email domain
  • GET /orgs/{org_id}/groups List the organization's member groups
  • POST /orgs/{org_id}/groups Create a member group
  • GET /orgs/{org_id}/groups/{group_id} Get a member group
  • PATCH /orgs/{org_id}/groups/{group_id} Rename or describe a member group
  • DELETE /orgs/{org_id}/groups/{group_id} Delete a member group
  • PUT /orgs/{org_id}/groups/{group_id}/members Set a group's members
  • GET /orgs/{org_id}/invites List invites
  • POST /orgs/{org_id}/invites Create an invite
  • GET /orgs/{org_id}/invites/{invite_id} Get an invite
  • DELETE /orgs/{org_id}/invites/{invite_id} Revoke an invite
  • GET /orgs/{org_id}/keys List the organization's integration keys
  • POST /orgs/{org_id}/keys Create an organization integration key
  • GET /orgs/{org_id}/keys/{key_id} Get an organization integration key
  • PATCH /orgs/{org_id}/keys/{key_id} Change an organization integration key
  • DELETE /orgs/{org_id}/keys/{key_id} Revoke an organization integration key
  • POST /orgs/{org_id}/keys/{key_id}/roll Roll an organization integration key
  • GET /orgs/{org_id}/members List organization members
  • GET /orgs/{org_id}/members/{user_id} Get an organization member
  • PATCH /orgs/{org_id}/members/{user_id} Change a member's role or email label
  • DELETE /orgs/{org_id}/members/{user_id} Remove a member or leave
  • PUT /orgs/{org_id}/members/{user_id}/devices/{device_id}/tags Set a member device's tags
  • GET /orgs/{org_id}/routes List the organization's routing rules
  • POST /orgs/{org_id}/routes Add a routing rule
  • GET /orgs/{org_id}/routes/{route_id} Get a routing rule
  • PATCH /orgs/{org_id}/routes/{route_id} Change a routing rule
  • DELETE /orgs/{org_id}/routes/{route_id} Delete a routing rule
  • POST /orgs/{org_id}/routes/apply Re-apply the routing rules
  • PUT /orgs/{org_id}/routes/order Reorder the routing rules
  • GET /orgs/{org_id}/sso Get the organization's single sign-on
  • PUT /orgs/{org_id}/sso Set up single sign-on
  • DELETE /orgs/{org_id}/sso Remove single sign-on
  • GET /orgs/{org_id}/tags List the organization's device tags
  • POST /orgs/{org_id}/tags Create a device tag
  • GET /orgs/{org_id}/tags/{tag_id} Get a device tag
  • PATCH /orgs/{org_id}/tags/{tag_id} Rename or describe a device tag
  • DELETE /orgs/{org_id}/tags/{tag_id} Delete a device tag
  • POST /orgs/{org_id}/tags/{tag_id}/devices Tag and untag member devices

Widgets

  • GET /widgets List widgets
  • POST /widgets Create widget
  • GET /widgets/{slug} Get widget
  • PATCH /widgets/{slug} Update widget
  • DELETE /widgets/{slug} Delete widget