{ "opencollection": "1.0.0", "info": { "name": "MagicBell apns integrations API", "version": "2.0.0" }, "items": [ { "info": { "name": "integrations", "type": "folder" }, "items": [ { "info": { "name": "List Integrations", "type": "http" }, "http": { "method": "GET", "url": "https://api.magicbell.com/v2/integrations", "params": [ { "name": "page[size]", "value": "", "type": "query" }, { "name": "page[after]", "value": "", "type": "query" }, { "name": "page[before]", "value": "", "type": "query" } ] }, "docs": "Lists all available and configured integrations for the project. Returns a summary of each integration including its type, status, and basic configuration information." }, { "info": { "name": "get_apns_integration", "type": "http" }, "http": { "method": "GET", "url": "https://api.magicbell.com/v2/integrations/apns" }, "docs": "Retrieves the current apns integration configurations for a specific integration type in the project. Returns configuration details and status information." }, { "info": { "name": "save_apns_integration", "type": "http" }, "http": { "method": "PUT", "url": "https://api.magicbell.com/v2/integrations/apns", "body": { "type": "json", "data": "{}" } }, "docs": "Creates or updates a apns integration for the project. Only administrators can configure integrations." }, { "info": { "name": "delete_apns_integration", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.magicbell.com/v2/integrations/apns" }, "docs": "Removes a apns integration configuration from the project. This will disable the integration's functionality within the project." }, { "info": { "name": "delete_apns_integration_by_id", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.magicbell.com/v2/integrations/apns/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Removes a specific apns integration instance by ID from the project." }, { "info": { "name": "get_awssns_integration", "type": "http" }, "http": { "method": "GET", "url": "https://api.magicbell.com/v2/integrations/awssns" }, "docs": "Retrieves the current awssns integration configurations for a specific integration type in the project. Returns configuration details and status information." }, { "info": { "name": "save_awssns_integration", "type": "http" }, "http": { "method": "PUT", "url": "https://api.magicbell.com/v2/integrations/awssns", "body": { "type": "json", "data": "{}" } }, "docs": "Creates or updates a awssns integration for the project. Only administrators can configure integrations." }, { "info": { "name": "delete_awssns_integration", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.magicbell.com/v2/integrations/awssns" }, "docs": "Removes a awssns integration configuration from the project. This will disable the integration's functionality within the project." }, { "info": { "name": "handle_awssns_webhook", "type": "http" }, "http": { "method": "POST", "url": "https://api.magicbell.com/v2/integrations/awssns/webhooks/incoming/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Receives and processes incoming webhook events from the awssns integration. Each integration can define its own webhook payload format and handling logic." }, { "info": { "name": "delete_awssns_integration_by_id", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.magicbell.com/v2/integrations/awssns/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Removes a specific awssns integration instance by ID from the project." }, { "info": { "name": "get_expo_integration", "type": "http" }, "http": { "method": "GET", "url": "https://api.magicbell.com/v2/integrations/expo" }, "docs": "Retrieves the current expo integration configurations for a specific integration type in the project. Returns configuration details and status information." }, { "info": { "name": "save_expo_integration", "type": "http" }, "http": { "method": "PUT", "url": "https://api.magicbell.com/v2/integrations/expo", "body": { "type": "json", "data": "{}" } }, "docs": "Creates or updates a expo integration for the project. Only administrators can configure integrations." }, { "info": { "name": "delete_expo_integration", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.magicbell.com/v2/integrations/expo" }, "docs": "Removes a expo integration configuration from the project. This will disable the integration's functionality within the project." }, { "info": { "name": "delete_expo_integration_by_id", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.magicbell.com/v2/integrations/expo/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Removes a specific expo integration instance by ID from the project." }, { "info": { "name": "get_fcm_integration", "type": "http" }, "http": { "method": "GET", "url": "https://api.magicbell.com/v2/integrations/fcm" }, "docs": "Retrieves the current fcm integration configurations for a specific integration type in the project. Returns configuration details and status information." }, { "info": { "name": "save_fcm_integration", "type": "http" }, "http": { "method": "PUT", "url": "https://api.magicbell.com/v2/integrations/fcm", "body": { "type": "json", "data": "{}" } }, "docs": "Creates or updates a fcm integration for the project. Only administrators can configure integrations." }, { "info": { "name": "delete_fcm_integration", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.magicbell.com/v2/integrations/fcm" }, "docs": "Removes a fcm integration configuration from the project. This will disable the integration's functionality within the project." }, { "info": { "name": "delete_fcm_integration_by_id", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.magicbell.com/v2/integrations/fcm/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Removes a specific fcm integration instance by ID from the project." }, { "info": { "name": "get_github_integration", "type": "http" }, "http": { "method": "GET", "url": "https://api.magicbell.com/v2/integrations/github" }, "docs": "Retrieves the current github integration configurations for a specific integration type in the project. Returns configuration details and status information." }, { "info": { "name": "save_github_integration", "type": "http" }, "http": { "method": "PUT", "url": "https://api.magicbell.com/v2/integrations/github", "body": { "type": "json", "data": "{}" } }, "docs": "Creates or updates a github integration for the project. Only administrators can configure integrations." }, { "info": { "name": "delete_github_integration", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.magicbell.com/v2/integrations/github" }, "docs": "Removes a github integration configuration from the project. This will disable the integration's functionality within the project." }, { "info": { "name": "handle_github_webhook", "type": "http" }, "http": { "method": "POST", "url": "https://api.magicbell.com/v2/integrations/github/webhooks/incoming/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Receives and processes incoming webhook events from the github integration. Each integration can define its own webhook payload format and handling logic." }, { "info": { "name": "delete_github_integration_by_id", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.magicbell.com/v2/integrations/github/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Removes a specific github integration instance by ID from the project." }, { "info": { "name": "get_inbox_integration", "type": "http" }, "http": { "method": "GET", "url": "https://api.magicbell.com/v2/integrations/inbox" }, "docs": "Retrieves the current inbox integration configurations for a specific integration type in the project. Returns configuration details and status information." }, { "info": { "name": "save_inbox_integration", "type": "http" }, "http": { "method": "PUT", "url": "https://api.magicbell.com/v2/integrations/inbox", "body": { "type": "json", "data": "{}" } }, "docs": "Creates or updates a inbox integration for the project. Only administrators can configure integrations." }, { "info": { "name": "delete_inbox_integration", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.magicbell.com/v2/integrations/inbox" }, "docs": "Removes a inbox integration configuration from the project. This will disable the integration's functionality within the project." }, { "info": { "name": "save_inbox_installation", "type": "http" }, "http": { "method": "POST", "url": "https://api.magicbell.com/v2/integrations/inbox/installations", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new installation of a inbox integration for a user. This endpoint is used when an integration needs to be set up with user-specific credentials or configuration." }, { "info": { "name": "start_inbox_installation", "type": "http" }, "http": { "method": "POST", "url": "https://api.magicbell.com/v2/integrations/inbox/installations/start" }, "docs": "Initiates the installation flow for a inbox integration. This is the first step in a multi-step installation process where user authorization or external service configuration may be required." }, { "info": { "name": "delete_inbox_integration_by_id", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.magicbell.com/v2/integrations/inbox/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Removes a specific inbox integration instance by ID from the project." }, { "info": { "name": "get_mailgun_integration", "type": "http" }, "http": { "method": "GET", "url": "https://api.magicbell.com/v2/integrations/mailgun" }, "docs": "Retrieves the current mailgun integration configurations for a specific integration type in the project. Returns configuration details and status information." }, { "info": { "name": "save_mailgun_integration", "type": "http" }, "http": { "method": "PUT", "url": "https://api.magicbell.com/v2/integrations/mailgun", "body": { "type": "json", "data": "{}" } }, "docs": "Creates or updates a mailgun integration for the project. Only administrators can configure integrations." }, { "info": { "name": "delete_mailgun_integration", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.magicbell.com/v2/integrations/mailgun" }, "docs": "Removes a mailgun integration configuration from the project. This will disable the integration's functionality within the project." }, { "info": { "name": "delete_mailgun_integration_by_id", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.magicbell.com/v2/integrations/mailgun/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Removes a specific mailgun integration instance by ID from the project." }, { "info": { "name": "get_ping_email_integration", "type": "http" }, "http": { "method": "GET", "url": "https://api.magicbell.com/v2/integrations/ping_email" }, "docs": "Retrieves the current ping_email integration configurations for a specific integration type in the project. Returns configuration details and status information." }, { "info": { "name": "save_ping_email_integration", "type": "http" }, "http": { "method": "PUT", "url": "https://api.magicbell.com/v2/integrations/ping_email", "body": { "type": "json", "data": "{}" } }, "docs": "Creates or updates a ping_email integration for the project. Only administrators can configure integrations." }, { "info": { "name": "delete_ping_email_integration", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.magicbell.com/v2/integrations/ping_email" }, "docs": "Removes a ping_email integration configuration from the project. This will disable the integration's functionality within the project." }, { "info": { "name": "delete_ping_email_integration_by_id", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.magicbell.com/v2/integrations/ping_email/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Removes a specific ping_email integration instance by ID from the project." }, { "info": { "name": "get_sendgrid_integration", "type": "http" }, "http": { "method": "GET", "url": "https://api.magicbell.com/v2/integrations/sendgrid" }, "docs": "Retrieves the current sendgrid integration configurations for a specific integration type in the project. Returns configuration details and status information." }, { "info": { "name": "save_sendgrid_integration", "type": "http" }, "http": { "method": "PUT", "url": "https://api.magicbell.com/v2/integrations/sendgrid", "body": { "type": "json", "data": "{}" } }, "docs": "Creates or updates a sendgrid integration for the project. Only administrators can configure integrations." }, { "info": { "name": "delete_sendgrid_integration", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.magicbell.com/v2/integrations/sendgrid" }, "docs": "Removes a sendgrid integration configuration from the project. This will disable the integration's functionality within the project." }, { "info": { "name": "delete_sendgrid_integration_by_id", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.magicbell.com/v2/integrations/sendgrid/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Removes a specific sendgrid integration instance by ID from the project." }, { "info": { "name": "get_ses_integration", "type": "http" }, "http": { "method": "GET", "url": "https://api.magicbell.com/v2/integrations/ses" }, "docs": "Retrieves the current ses integration configurations for a specific integration type in the project. Returns configuration details and status information." }, { "info": { "name": "save_ses_integration", "type": "http" }, "http": { "method": "PUT", "url": "https://api.magicbell.com/v2/integrations/ses", "body": { "type": "json", "data": "{}" } }, "docs": "Creates or updates a ses integration for the project. Only administrators can configure integrations." }, { "info": { "name": "delete_ses_integration", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.magicbell.com/v2/integrations/ses" }, "docs": "Removes a ses integration configuration from the project. This will disable the integration's functionality within the project." }, { "info": { "name": "delete_ses_integration_by_id", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.magicbell.com/v2/integrations/ses/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Removes a specific ses integration instance by ID from the project." }, { "info": { "name": "get_slack_integration", "type": "http" }, "http": { "method": "GET", "url": "https://api.magicbell.com/v2/integrations/slack" }, "docs": "Retrieves the current slack integration configurations for a specific integration type in the project. Returns configuration details and status information." }, { "info": { "name": "save_slack_integration", "type": "http" }, "http": { "method": "PUT", "url": "https://api.magicbell.com/v2/integrations/slack", "body": { "type": "json", "data": "{}" } }, "docs": "Creates or updates a slack integration for the project. Only administrators can configure integrations." }, { "info": { "name": "delete_slack_integration", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.magicbell.com/v2/integrations/slack" }, "docs": "Removes a slack integration configuration from the project. This will disable the integration's functionality within the project." }, { "info": { "name": "save_slack_installation", "type": "http" }, "http": { "method": "POST", "url": "https://api.magicbell.com/v2/integrations/slack/installations", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new installation of a slack integration for a user. This endpoint is used when an integration needs to be set up with user-specific credentials or configuration." }, { "info": { "name": "finish_slack_installation", "type": "http" }, "http": { "method": "POST", "url": "https://api.magicbell.com/v2/integrations/slack/installations/finish", "body": { "type": "json", "data": "{}" } }, "docs": "Completes the installation flow for a slack integration. This endpoint is typically called after the user has completed any required authorization steps with slack." }, { "info": { "name": "start_slack_installation", "type": "http" }, "http": { "method": "POST", "url": "https://api.magicbell.com/v2/integrations/slack/installations/start", "body": { "type": "json", "data": "{}" } }, "docs": "Initiates the installation flow for a slack integration. This is the first step in a multi-step installation process where user authorization or external service configuration may be required." }, { "info": { "name": "delete_slack_integration_by_id", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.magicbell.com/v2/integrations/slack/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Removes a specific slack integration instance by ID from the project." }, { "info": { "name": "get_stripe_integration", "type": "http" }, "http": { "method": "GET", "url": "https://api.magicbell.com/v2/integrations/stripe" }, "docs": "Retrieves the current stripe integration configurations for a specific integration type in the project. Returns configuration details and status information." }, { "info": { "name": "save_stripe_integration", "type": "http" }, "http": { "method": "PUT", "url": "https://api.magicbell.com/v2/integrations/stripe", "body": { "type": "json", "data": "{}" } }, "docs": "Creates or updates a stripe integration for the project. Only administrators can configure integrations." }, { "info": { "name": "delete_stripe_integration", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.magicbell.com/v2/integrations/stripe" }, "docs": "Removes a stripe integration configuration from the project. This will disable the integration's functionality within the project." }, { "info": { "name": "handle_stripe_webhook", "type": "http" }, "http": { "method": "POST", "url": "https://api.magicbell.com/v2/integrations/stripe/webhooks/incoming/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Receives and processes incoming webhook events from the stripe integration. Each integration can define its own webhook payload format and handling logic." }, { "info": { "name": "delete_stripe_integration_by_id", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.magicbell.com/v2/integrations/stripe/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Removes a specific stripe integration instance by ID from the project." }, { "info": { "name": "get_templates_integration", "type": "http" }, "http": { "method": "GET", "url": "https://api.magicbell.com/v2/integrations/templates" }, "docs": "Retrieves the current templates integration configurations for a specific integration type in the project. Returns configuration details and status information." }, { "info": { "name": "save_templates_integration", "type": "http" }, "http": { "method": "PUT", "url": "https://api.magicbell.com/v2/integrations/templates", "body": { "type": "json", "data": "{}" } }, "docs": "Creates or updates a templates integration for the project. Only administrators can configure integrations." }, { "info": { "name": "delete_templates_integration", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.magicbell.com/v2/integrations/templates" }, "docs": "Removes a templates integration configuration from the project. This will disable the integration's functionality within the project." }, { "info": { "name": "save_templates_installation", "type": "http" }, "http": { "method": "POST", "url": "https://api.magicbell.com/v2/integrations/templates/installations", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new installation of a templates integration for a user. This endpoint is used when an integration needs to be set up with user-specific credentials or configuration." }, { "info": { "name": "delete_templates_integration_by_id", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.magicbell.com/v2/integrations/templates/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Removes a specific templates integration instance by ID from the project." }, { "info": { "name": "get_twilio_integration", "type": "http" }, "http": { "method": "GET", "url": "https://api.magicbell.com/v2/integrations/twilio" }, "docs": "Retrieves the current twilio integration configurations for a specific integration type in the project. Returns configuration details and status information." }, { "info": { "name": "save_twilio_integration", "type": "http" }, "http": { "method": "PUT", "url": "https://api.magicbell.com/v2/integrations/twilio", "body": { "type": "json", "data": "{}" } }, "docs": "Creates or updates a twilio integration for the project. Only administrators can configure integrations." }, { "info": { "name": "delete_twilio_integration", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.magicbell.com/v2/integrations/twilio" }, "docs": "Removes a twilio integration configuration from the project. This will disable the integration's functionality within the project." }, { "info": { "name": "delete_twilio_integration_by_id", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.magicbell.com/v2/integrations/twilio/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Removes a specific twilio integration instance by ID from the project." }, { "info": { "name": "get_web_push_integration", "type": "http" }, "http": { "method": "GET", "url": "https://api.magicbell.com/v2/integrations/web_push" }, "docs": "Retrieves the current web_push integration configurations for a specific integration type in the project. Returns configuration details and status information." }, { "info": { "name": "save_web_push_integration", "type": "http" }, "http": { "method": "PUT", "url": "https://api.magicbell.com/v2/integrations/web_push", "body": { "type": "json", "data": "{}" } }, "docs": "Creates or updates a web_push integration for the project. Only administrators can configure integrations." }, { "info": { "name": "delete_web_push_integration", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.magicbell.com/v2/integrations/web_push" }, "docs": "Removes a web_push integration configuration from the project. This will disable the integration's functionality within the project." }, { "info": { "name": "save_web_push_installation", "type": "http" }, "http": { "method": "POST", "url": "https://api.magicbell.com/v2/integrations/web_push/installations", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new installation of a web_push integration for a user. This endpoint is used when an integration needs to be set up with user-specific credentials or configuration." }, { "info": { "name": "start_web_push_installation", "type": "http" }, "http": { "method": "POST", "url": "https://api.magicbell.com/v2/integrations/web_push/installations/start" }, "docs": "Initiates the installation flow for a web_push integration. This is the first step in a multi-step installation process where user authorization or external service configuration may be required." }, { "info": { "name": "delete_web_push_integration_by_id", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.magicbell.com/v2/integrations/web_push/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Removes a specific web_push integration instance by ID from the project." } ] } ], "bundled": true }