The integrations API from MagicBell — 42 operation(s) for integrations.
openapi: 3.0.3
info:
title: MagicBell apns integrations API
description: OpenAPI 3.0.3 Specification for MagicBell API.
contact:
name: MagicBell
url: https://magicbell.com
email: hello@magicbell.com
version: 2.0.0
servers:
- url: https://api.magicbell.com/v2
description: MagicBell REST API Base URL
tags:
- name: integrations
paths:
/integrations:
get:
tags:
- integrations
summary: List Integrations
description: Lists all available and configured integrations for the project. Returns a summary of each integration including its type, status, and basic configuration information.
operationId: list_integrations
parameters:
- name: page[size]
in: query
required: false
schema:
type: integer
- name: page[after]
in: query
required: false
schema:
type: string
- name: page[before]
in: query
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayOfIntegrationObjects'
/integrations/apns:
delete:
tags:
- integrations
description: Removes a apns integration configuration from the project. This will disable the integration's functionality within the project.
operationId: delete_apns_integration
responses:
'204':
description: No Content
x-meta:
channel: mobile_push
displayName: APNs
name: apns
get:
tags:
- integrations
description: Retrieves the current apns integration configurations for a specific integration type in the project. Returns configuration details and status information.
operationId: get_apns_integration
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayOfAPNSConfigObjects'
put:
tags:
- integrations
description: Creates or updates a apns integration for the project. Only administrators can configure integrations.
operationId: save_apns_integration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/APNSConfig'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/APNSConfig'
x-meta:
channel: mobile_push
displayName: APNs
name: apns
/integrations/apns/{id}:
delete:
tags:
- integrations
description: Removes a specific apns integration instance by ID from the project.
operationId: delete_apns_integration_by_id
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'204':
description: No Content
x-meta:
channel: mobile_push
displayName: APNs
name: apns
/integrations/awssns:
delete:
tags:
- integrations
description: Removes a awssns integration configuration from the project. This will disable the integration's functionality within the project.
operationId: delete_awssns_integration
responses:
'204':
description: No Content
x-meta:
displayName: Amazon SNS
name: awssns
get:
tags:
- integrations
description: Retrieves the current awssns integration configurations for a specific integration type in the project. Returns configuration details and status information.
operationId: get_awssns_integration
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayOfAWSSNSConfigObjects'
put:
tags:
- integrations
description: Creates or updates a awssns integration for the project. Only administrators can configure integrations.
operationId: save_awssns_integration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AWSSNSConfig'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AWSSNSConfig'
x-forbid-unknown-cookie: true
x-forbid-unknown-header: true
x-forbid-unknown-path: true
x-forbid-unknown-query: true
x-meta:
displayName: Amazon SNS
name: awssns
/integrations/awssns/webhooks/incoming/{id}:
post:
tags:
- integrations
description: Receives and processes incoming webhook events from the awssns integration. Each integration can define its own webhook payload format and handling logic.
operationId: handle_awssns_webhook
parameters:
- name: id
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AWSSNSWebhookEvent'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/AWSSNSWebhookEvent'
/integrations/awssns/{id}:
delete:
tags:
- integrations
description: Removes a specific awssns integration instance by ID from the project.
operationId: delete_awssns_integration_by_id
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'204':
description: No Content
x-meta:
displayName: Amazon SNS
name: awssns
/integrations/expo:
delete:
tags:
- integrations
description: Removes a expo integration configuration from the project. This will disable the integration's functionality within the project.
operationId: delete_expo_integration
responses:
'204':
description: No Content
x-meta:
channel: mobile_push
displayName: Expo
name: expo
get:
tags:
- integrations
description: Retrieves the current expo integration configurations for a specific integration type in the project. Returns configuration details and status information.
operationId: get_expo_integration
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayOfExpoConfigObjects'
put:
tags:
- integrations
description: Creates or updates a expo integration for the project. Only administrators can configure integrations.
operationId: save_expo_integration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExpoConfig'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ExpoConfig'
x-meta:
channel: mobile_push
displayName: Expo
name: expo
/integrations/expo/{id}:
delete:
tags:
- integrations
description: Removes a specific expo integration instance by ID from the project.
operationId: delete_expo_integration_by_id
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'204':
description: No Content
x-meta:
channel: mobile_push
displayName: Expo
name: expo
/integrations/fcm:
delete:
tags:
- integrations
description: Removes a fcm integration configuration from the project. This will disable the integration's functionality within the project.
operationId: delete_fcm_integration
responses:
'204':
description: No Content
x-meta:
channel: mobile_push
displayName: FCM
name: fcm
get:
tags:
- integrations
description: Retrieves the current fcm integration configurations for a specific integration type in the project. Returns configuration details and status information.
operationId: get_fcm_integration
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayOfFCMConfigObjects'
put:
tags:
- integrations
description: Creates or updates a fcm integration for the project. Only administrators can configure integrations.
operationId: save_fcm_integration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FCMConfig'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/FCMConfig'
x-meta:
channel: mobile_push
displayName: FCM
name: fcm
/integrations/fcm/{id}:
delete:
tags:
- integrations
description: Removes a specific fcm integration instance by ID from the project.
operationId: delete_fcm_integration_by_id
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'204':
description: No Content
x-meta:
channel: mobile_push
displayName: FCM
name: fcm
/integrations/github:
delete:
tags:
- integrations
description: Removes a github integration configuration from the project. This will disable the integration's functionality within the project.
operationId: delete_github_integration
responses:
'204':
description: No Content
x-meta:
displayName: GitHub
name: github
get:
tags:
- integrations
description: Retrieves the current github integration configurations for a specific integration type in the project. Returns configuration details and status information.
operationId: get_github_integration
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayOfGithubConfigObjects'
put:
tags:
- integrations
description: Creates or updates a github integration for the project. Only administrators can configure integrations.
operationId: save_github_integration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GithubConfig'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GithubConfig'
x-forbid-unknown-cookie: true
x-forbid-unknown-header: true
x-forbid-unknown-path: true
x-forbid-unknown-query: true
x-meta:
displayName: GitHub
name: github
/integrations/github/webhooks/incoming/{id}:
post:
tags:
- integrations
description: Receives and processes incoming webhook events from the github integration. Each integration can define its own webhook payload format and handling logic.
operationId: handle_github_webhook
parameters:
- name: id
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GithubWebhookEvent'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/GithubWebhookEvent'
/integrations/github/{id}:
delete:
tags:
- integrations
description: Removes a specific github integration instance by ID from the project.
operationId: delete_github_integration_by_id
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'204':
description: No Content
x-meta:
displayName: GitHub
name: github
/integrations/inbox:
delete:
tags:
- integrations
description: Removes a inbox integration configuration from the project. This will disable the integration's functionality within the project.
operationId: delete_inbox_integration
responses:
'204':
description: No Content
x-meta:
displayName: Inbox
name: inbox
get:
tags:
- integrations
description: Retrieves the current inbox integration configurations for a specific integration type in the project. Returns configuration details and status information.
operationId: get_inbox_integration
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayOfInboxConfigObjects'
put:
tags:
- integrations
description: Creates or updates a inbox integration for the project. Only administrators can configure integrations.
operationId: save_inbox_integration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InboxConfig'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/InboxConfig'
x-meta:
displayName: Inbox
name: inbox
/integrations/inbox/installations:
post:
tags:
- integrations
description: 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.
operationId: save_inbox_installation
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InboxConfig'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/InboxConfig'
/integrations/inbox/installations/start:
post:
tags:
- integrations
description: 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.
operationId: start_inbox_installation
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/InboxConfig'
/integrations/inbox/{id}:
delete:
tags:
- integrations
description: Removes a specific inbox integration instance by ID from the project.
operationId: delete_inbox_integration_by_id
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'204':
description: No Content
x-meta:
displayName: Inbox
name: inbox
/integrations/mailgun:
delete:
tags:
- integrations
description: Removes a mailgun integration configuration from the project. This will disable the integration's functionality within the project.
operationId: delete_mailgun_integration
responses:
'204':
description: No Content
x-meta:
channel: email
displayName: Mailgun
name: mailgun
get:
tags:
- integrations
description: Retrieves the current mailgun integration configurations for a specific integration type in the project. Returns configuration details and status information.
operationId: get_mailgun_integration
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayOfMailgunConfigObjects'
put:
tags:
- integrations
description: Creates or updates a mailgun integration for the project. Only administrators can configure integrations.
operationId: save_mailgun_integration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MailgunConfig'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/MailgunConfig'
x-meta:
channel: email
displayName: Mailgun
name: mailgun
/integrations/mailgun/{id}:
delete:
tags:
- integrations
description: Removes a specific mailgun integration instance by ID from the project.
operationId: delete_mailgun_integration_by_id
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'204':
description: No Content
x-meta:
channel: email
displayName: Mailgun
name: mailgun
/integrations/ping_email:
delete:
tags:
- integrations
description: Removes a ping_email integration configuration from the project. This will disable the integration's functionality within the project.
operationId: delete_ping_email_integration
responses:
'204':
description: No Content
x-meta:
channel: email
displayName: Ping Email
name: ping_email
get:
tags:
- integrations
description: Retrieves the current ping_email integration configurations for a specific integration type in the project. Returns configuration details and status information.
operationId: get_ping_email_integration
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayOfPingConfigObjects'
put:
tags:
- integrations
description: Creates or updates a ping_email integration for the project. Only administrators can configure integrations.
operationId: save_ping_email_integration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PingConfig'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PingConfig'
x-meta:
channel: email
displayName: Ping Email
name: ping_email
/integrations/ping_email/{id}:
delete:
tags:
- integrations
description: Removes a specific ping_email integration instance by ID from the project.
operationId: delete_ping_email_integration_by_id
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'204':
description: No Content
x-meta:
channel: email
displayName: Ping Email
name: ping_email
/integrations/sendgrid:
delete:
tags:
- integrations
description: Removes a sendgrid integration configuration from the project. This will disable the integration's functionality within the project.
operationId: delete_sendgrid_integration
responses:
'204':
description: No Content
x-meta:
channel: email
displayName: SendGrid
name: sendgrid
get:
tags:
- integrations
description: Retrieves the current sendgrid integration configurations for a specific integration type in the project. Returns configuration details and status information.
operationId: get_sendgrid_integration
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayOfSendgridConfigObjects'
put:
tags:
- integrations
description: Creates or updates a sendgrid integration for the project. Only administrators can configure integrations.
operationId: save_sendgrid_integration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SendgridConfig'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SendgridConfig'
x-meta:
channel: email
displayName: SendGrid
name: sendgrid
/integrations/sendgrid/{id}:
delete:
tags:
- integrations
description: Removes a specific sendgrid integration instance by ID from the project.
operationId: delete_sendgrid_integration_by_id
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'204':
description: No Content
x-meta:
channel: email
displayName: SendGrid
name: sendgrid
/integrations/ses:
delete:
tags:
- integrations
description: Removes a ses integration configuration from the project. This will disable the integration's functionality within the project.
operationId: delete_ses_integration
responses:
'204':
description: No Content
x-meta:
channel: email
displayName: Amazon SES
name: ses
get:
tags:
- integrations
description: Retrieves the current ses integration configurations for a specific integration type in the project. Returns configuration details and status information.
operationId: get_ses_integration
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayOfSESConfigObjects'
put:
tags:
- integrations
description: Creates or updates a ses integration for the project. Only administrators can configure integrations.
operationId: save_ses_integration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SESConfig'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SESConfig'
x-meta:
channel: email
displayName: Amazon SES
name: ses
/integrations/ses/{id}:
delete:
tags:
- integrations
description: Removes a specific ses integration instance by ID from the project.
operationId: delete_ses_integration_by_id
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'204':
description: No Content
x-meta:
channel: email
displayName: Amazon SES
name: ses
/integrations/slack:
delete:
tags:
- integrations
description: Removes a slack integration configuration from the project. This will disable the integration's functionality within the project.
operationId: delete_slack_integration
responses:
'204':
description: No Content
x-meta:
channel: slack
displayName: Slack
name: slack
get:
tags:
- integrations
description: Retrieves the current slack integration configurations for a specific integration type in the project. Returns configuration details and status information.
operationId: get_slack_integration
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayOfSlackConfigObjects'
put:
tags:
- integrations
description: Creates or updates a slack integration for the project. Only administrators can configure integrations.
operationId: save_slack_integration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SlackConfig'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SlackConfig'
x-meta:
channel: slack
displayName: Slack
name: slack
/integrations/slack/installations:
post:
tags:
- integrations
description: 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.
operationId: save_slack_installation
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SlackInstallation'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/SlackInstallation'
/integrations/slack/installations/finish:
post:
tags:
- integrations
description: Completes the installation flow for a slack integration. This endpoint is typically called after the user has completed any required authorization steps with slack.
operationId: finish_slack_installation
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SlackFinishInstallResponse'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/SlackInstallation'
/integrations/slack/installations/start:
post:
tags:
- integrations
description: 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.
operationId: start_slack_installation
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SlackStartInstall'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/SlackStartInstallResponseContent'
x-forbid-unknown-cookie: true
x-forbid-unknown-header: true
x-forbid-unknown-path: true
x-forbid-unknown-query: true
/integrations/slack/{id}:
delete:
tags:
- integrations
description: Removes a specific slack integration instance by ID from the project.
operationId: delete_slack_integration_by_id
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'204':
description: No Content
x-meta:
channel: slack
displayName: Slack
name: slack
/integrations/stripe:
delete:
tags:
- integrations
description: Removes a stripe integration configuration from the project. This will disable the integration's functionality within the project.
operationId: delete_stripe_integration
responses:
'204':
description: No Content
x-meta:
displayName: Stripe
name: stripe
get:
tags:
- integrations
description: Retrieves the current stripe integration configurations for a specific integration type in the project. Returns configuration details and status information.
operationId: get_stripe_integration
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayOfStripeConfigObjects'
put:
tags:
- integrations
description: Creates or updates a stripe integration for the project. Only administrators can configure integrations.
operationId: save_stripe_integration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StripeConfig'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/StripeConfig'
x-forbid-unknown-cookie: true
x-forbid-unknown-header: true
x-forbid-unknown-path: true
x-forbid-unknown-query: true
x-meta:
displayName: Stripe
name: stripe
/integrations/stripe/webhooks/incoming/{id}:
post:
tags:
- integrations
description: Receives and processes incoming webhook events from the stripe integration. Each integration can define its own webhook payload format and handling logic.
operationId: handle_stripe_webhook
parameters:
- name: id
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StripeWebhookEvent'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/StripeWebhookEvent'
/integrations/stripe/{id}:
delete:
tags:
- integrations
description: Removes a specific stripe integration instance by ID from the project.
operationId: delete_stripe_integration_by_id
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'204':
description: No Content
x-meta:
displayName: Stripe
name: stripe
/integrations/templates:
delete:
tags:
- integrations
description: Removes a templates integration configuration from the project. This will disable the integration's functionality within the project.
operationId: delete_templates_integration
responses:
'204':
description: No Content
x-meta:
displayName: Templates
name: templates
get:
tags:
- integrations
description: Retrieves the current templates integration configurations for a specific integration type in the project. Returns configuration details and status information.
operationId: get_templates_integration
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayOfTemplatesConfigObjects'
put:
tags:
- integrations
description: Creates or updates a templates integration for the project. Only administrators can configure integrations.
operationId: save_templates_integration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TemplatesConfig'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TemplatesConfig'
x-meta:
displayName: Templates
name: templates
/integrations/templates/installations:
post:
tags:
- integrations
description: 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.
operationId: save_templates_installation
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TemplatesInstallation'
responses:
'201':
description: Created
# --- truncated at 32 KB (79 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/magicbell/refs/heads/main/openapi/magicbell-integrations-api-openapi.yml