Create Integration

POST /integrations
Copied
Arrow
                https://api.ocamba.com/v1/hood/integrations

Creates an Integration

Request Body Schema
Arrow
Name
Description
namestringrequired
The Name of the integration. A string of minimal 1 and maximal 100 characters.


Example: My First Integration
provider_idstringrequired
The id of the provider. To check for valid provider id's you can list them on the /providers endpoint.


Example: 1000
settingstwilio-integration

custom-email-integration

mandrill-integration

sendgrid-integration

mitto-integration

mailgun-integration

telegram-integrationrequired
The settings of the integration. These are specific by provider. The input params differ by provider.
twilio_sms
Name
Description
account_sidstring
A Twilio Account SID is a 34-character alphanumeric identifier that can be found on the dashboard when logging into the Twilio Console.


Example: ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
auth_tokenstring
The Auth Token is a secret key that used by Twilio to authenticate API requests that can be found on the dashboard when logging into the Twilio Console.


Example: Jd4pbV9BtHC6Q9EdymQhZ4aJgZ8AgFi9
default_phone_numberstring
Twilio phone number


Example: +14155552671
custom_email_provider
Name
Description
default_sender_emailstring
The 'from' email address.


Example: [email protected]
default_sender_namestring
The name that will be displayed as the sender name.


Example: John Doe
passwordstring
The password for your email account registered on the email domain you've specified.


Example: yourExamplePassword123
portstring
The SMTP port your email domain uses.


Example: 587
sending_domainstring
Email domain.


Example: ex.example.com
usernamestring
The username registered on your email domain through which you're actually sending the email.


Example: [email protected]
mandrill_email
Name
Description
api_keystring
A Mandrill Account API key. Provided to you by the Mandrill platform


Example: ad-79XXXXXXXXXXXXXXXXXXXXXX
default_reply_to_emailstring
The reply-to email address that will be displayed in the email.


Example: [email protected]
default_sender_emailstring
The email address which will be the actual sender of the notification


Example: [email protected]
default_sender_namestring
The name that will be displayed as the sender name


Example: John Doe
smtp_usernamestring
The SMTP host name for Mandrill.


Example: exampleName
sendgrid_email
Name
Description
api_keystring
A Mandrill Account API key. Provided to you by the SendGrid platform.


Example: SG.EGXXXXXXXXXXXXXXXXXXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXX
default_reply_to_emailstring
The reply-to email address that will be displayed in the email. If the reply-to email is provided, it has to match the reply-to email from your SendGrid account.


Example: [email protected]
default_sender_emailstring
The email address which will be the actual sender of the notification. This has to match the sender email from your SendGrid account.


Example: [email protected]
default_sender_namestring
The name that will be displayed as the sender name.


Example: John Doe
mitto_sms
Name
Description
api_keystring
The api key generated by the Mitto platform. Use this key to successfully send messages via this provider.


Example: AScs8XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
sender_namestring
The name of the sender that will be displayed to the user receiving the message.


Example: Ocamba Integration
mailgun_email
Name
Description
api_keystring
A Mailgun Account API key. Provided to you by the Mailgun platform.


Example: 563cXXXXXXXXXXXXXXXXXXX-XXXXXXXXX-XXXXXXXXX
domainstring
The domain of your Mailgun account. Provided to you by the Mailgun platform.


Example: sandboxXXXXXXXXXXXXXXXXXXXXXXXXX.mailgun.org
sender_emailstring
The email address which will be the actual sender of the notification.


Example: [email protected]
sender_namestring
The sender name that will appear when a user recieves the email.


Example: John Doe
telegram
Name
Description
auth_tokenstring
A telegram bot authentication token. Provided by the telegram API.


Example: 123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11
chat_idstring
A telegram unique chat identifier. Provided by the telegram API.


Example: 8171131924
statusstringrequired
The status of the integration. Active integrations can be used to send SMS messages.


Example: active

Possible values: active | inactive
typestringrequired
The type of the integration. It depends on the selected provider type.

Possible values: sms | email | telegram
Response status codes
Arrow
201 - Created
Arrow
note
1 The settings may differ according to the provider id.
Request examples
Copied
Arrow
Twilio Arrow
  • Twilio
  • Mitto
  • Custom Email Provider
  • Mailchimp
  • SendGrid
  • Mailgun
{
  "name": "Example Twilio",
  "provider_id": "1000",
  "settings": {
    "account_sid": "AC7XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "auth_token": "464XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "default_phone_number": "+121XXXXXXXXX"
  },
  "status": "active"
}

{
  "name": "Example Mitto",
  "provider_id": "1004",
  "settings": {
    "api_key": "AScs8XXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "sender_name": "Example Name",
  },
  "status": "active"
}

{
  "name": "Example Custom",
  "provider_id": "1001",
  "settings": {
    "default_sender_email": "[email protected]",
    "default_sender_name": "John Doe",
    "sending_domain": "ex.example.com",
    "port": "587",
    "username": "[email protected]",
    "password": "yourPassword123"
  },
  "status": "active"
}

{
  "name": "Example Mailchimp",
  "provider_id": "1002",
  "settings": {
    "api_key": "md-c8XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "default_sender_name": "Example Name",
    "default_sender_email": "[email protected]",
    "default_reply_to_email":"[email protected]"
  },
  "status": "active"
}

{
  "name": "Example SendGrid",
  "provider_id": "1003",
  "settings": {
    "api_key": "SG.EKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "default_sender_name": "Example Name",
    "default_sender_email": "[email protected]",
    "default_reply_to_email":"[email protected]"
  },
  "status": "active"
}

{
  "name": "Example Mailgun",
  "provider_id": "1005",
  "settings": {
    "api_key": "568cXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-XXXXXXXX-XXXXXXXX",
    "domain":"sandboxXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.mailgun.org"
    "sender_email": "[email protected]",
    "sender_name": "John Doe",
  },
  "status": "active"
}
Response examples
Copied
Arrow
201 Arrow
  • 201
{
  "id": "1165",
  "company_id": "6197120",
  "name": "Example",
  "type": "sms",
  "provider_id": "1000",
  "settings": {
    "account_sid": "AC7XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "auth_token": "464XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "default_phone_number": "+121XXXXXXXXX"
  },
  "status": "active",
  "is_default": false
}