مرجع PushWard API
المرجع الكامل لواجهة REST الخاصة بـ API الأنشطة المباشرة في iOS من PushWard وللإشعارات وعناصر الواجهة. استكشف كل نقطة نهاية أدناه، أو اقرأ دليل الواجهة البرمجية للمصادقة وأمثلة مشروحة.
نقاط النهاية
جميع المسارات نسبية إلى https://api.pushward.app
Activities
- GET
/activitiesList activities - POST
/activitiesCreate activity - GET
/activities/{slug}Get activity - PATCH
/activities/{slug}Update activity - DELETE
/activities/{slug}Delete activity
Permissions
- GET
/activities/{slug}/permissionsList permissions on activity - POST
/activities/{slug}/permissionsGrant permission on activity - GET
/permissionsList permissions - PATCH
/permissions/{id}Update permission role - DELETE
/permissions/{id}Revoke or leave permission - POST
/permissions/patternsGrant permission on slug pattern
System
- GET
/app/onboardingGet onboarding state - PATCH
/app/onboardingUpdate onboarding state - GET
/healthHealth check بدون مصادقة
Auth
- GET
/auth/meGet current user profile - PATCH
/auth/meUpdate current user profile
Devices
- GET
/devicesList devices - GET
/devices/{device_id}Get device - PATCH
/devices/{device_id}Rename device - DELETE
/devices/{device_id}Remove device - GET
/devices/{device_id}/subscriptionsList 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
- POST
/emailsSend transactional email - GET
/emails/recipientsList email recipients - POST
/emails/recipientsRegister email recipient - DELETE
/emails/recipients/{id}Delete email recipient - POST
/emails/recipients/{id}/resendResend recipient confirmation
Integration Keys
- GET
/integrations/keysList integration keys - POST
/integrations/keysCreate integration key - PATCH
/integrations/keys/{key_id}Update integration key - DELETE
/integrations/keys/{key_id}Revoke integration key - POST
/integrations/keys/{key_id}/rollRoll integration key
Notifications
- POST
/notificationsCreate notification - GET
/notifications/answersStream notification answers - GET
/notifications/answers/{id}Get notification answer - GET
/notifications/receipts/{id}Get notification receipt - POST
/notifications/receipts/{id}/cancelCancel notification receipt - POST
/notifications/receipts/cancelCancel notification receipts by tag - POST
/notifications/retractRetract notifications by collapse_id - GET
/notifications/scheduledList scheduled notifications - POST
/notifications/scheduledSchedule notification - GET
/notifications/scheduled/{id}Get scheduled notification - DELETE
/notifications/scheduled/{id}Cancel scheduled notification
Organizations
- GET
/orgsList my organizations - GET
/orgs/{org_id}Get an organization - PATCH
/orgs/{org_id}Rename an organization - GET
/orgs/{org_id}/audit-eventsOrganization audit log - GET
/orgs/{org_id}/audit-events/exportExport the organization audit log - GET
/orgs/{org_id}/billingGet an organization's plan and billing - GET
/orgs/{org_id}/billing/invoicesList the plan's paid invoices - GET
/orgs/{org_id}/billing/invoices/{transaction_id}/pdfGet a link to an invoice PDF - GET
/orgs/{org_id}/devicesList the members' devices - GET
/orgs/{org_id}/domainsList the organization's email domains - POST
/orgs/{org_id}/domainsAdd an email domain - DELETE
/orgs/{org_id}/domains/{domain_id}Remove an email domain - POST
/orgs/{org_id}/domains/{domain_id}/verifyVerify an email domain - GET
/orgs/{org_id}/groupsList the organization's member groups - POST
/orgs/{org_id}/groupsCreate 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}/membersSet a group's members - GET
/orgs/{org_id}/invitesList invites - POST
/orgs/{org_id}/invitesCreate 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}/keysList the organization's integration keys - POST
/orgs/{org_id}/keysCreate 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}/rollRoll an organization integration key - GET
/orgs/{org_id}/membersList 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}/tagsSet a member device's tags - GET
/orgs/{org_id}/routesList the organization's routing rules - POST
/orgs/{org_id}/routesAdd 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/applyRe-apply the routing rules - PUT
/orgs/{org_id}/routes/orderReorder the routing rules - GET
/orgs/{org_id}/ssoGet the organization's single sign-on - PUT
/orgs/{org_id}/ssoSet up single sign-on - DELETE
/orgs/{org_id}/ssoRemove single sign-on - GET
/orgs/{org_id}/tagsList the organization's device tags - POST
/orgs/{org_id}/tagsCreate 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}/devicesTag and untag member devices
Widgets
- GET
/widgetsList widgets - POST
/widgetsCreate widget - GET
/widgets/{slug}Get widget - PATCH
/widgets/{slug}Update widget - DELETE
/widgets/{slug}Delete widget