List Providers

Copied

                https://api.ocamba.com/v1/hood/providers

Returns a list of Providers

query Parameters

Name

Description

fieldsstring

Fields parameter represents array of dimensions and measures. Dimensions are used to categorize, segment, and reveal the details of the data. Measures contain numeric, quantitative values that can be measured. At least one measure is required.

Example: fields=field1,field2,field3

viewstring

Hood API returns full representation of the resource using the "view=full" query parameter. If not specified, the default view will be used.

Note that the "fields" parameter has precedence over the "view" parameter.

Example: view=full/default

sortstring

Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix "-" for descending).

Examples:
GET /VERSION/hood/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /VERSION/hood/RESOURCE_NAME?sort=-id → sorts per id descending
GET /VERSION/hood/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.

Example: sort=-field1,field2

pagestring

The page number indicates which set of items will be returned in the response. The format of request is "page=N,M" where 'N' (required) represents page number and 'M' (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.

Example: page=1,10

q_fieldsstring

Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /VERSION/hood/RESOURCE_NAME?q=sou&q_fields=lname → API retuns a certain resource whose lname contains string 'sou'.
GET /VERSION/hood/RESOURCE_NAME?q=sou&q_fields=fname,lname,email → API returns a certain resource that contain string 'sou' in any of the specified fields.

See tips for the list of searchable parameters.

qstring

Set the q parameter value to search for a keyword or search term.

Example:
GET /VERSION/hood/RESOURCE_NAME?q=sou → returns a certain resource that contain string 'sou'

See tips for the list of searchable parameters.

Response status codes

200 - OK

Name

Description

items[ integrations ]

An array of all items.

Integration

Name

Description

company_idstring

A unique company identifier generated by the Ocamba platform.

Example: 1000000

create_timestring

Timezone: GMT.

Example: 2021-10-29 12:47:00

effective_statusstring

The effective status of the integration. It may differ from the status field, if not tested or if the test is not successful.

Example: active

idstring

A unique identifier of the Integration, generated by the Ocamba platform.

Example: 1000

is_defaultboolean

Determines whether an integration is default or not. Default integration will be useed for sending messages to a user, unless otherwise specified.

Example: true

namestring

The Name of the integration. A string of minimal 1 and maximal 100 characters.

Example: My First Integration

providerproviders

Provider

Name

Description

company_idstring

A unique identifier of the Company the user is a member of, generated by the Ocamba platform.

Example: 1000000

create_timestring

Timezone: GMT.

Example: 2021-10-29 12:47:00

idstring

A unique identifier of the Provider, generated by the Ocamba platform.

Example: 1000000

logostring

The provider logo. String of maximum 100 characters.

Example: https://example.com/logo.jpg

namestring

The name of the Provider.

Example: twilio

settings[ provider-settings ]

The settings of the provider required for the integration to be successful.

Settings

Name

Description

deprecatedboolean

Determines whether this parameter is deprecated.

Example: true

namestring

The name of the parameter, from 1 to 100 characters range.

Example: p_key

requiredboolean

Determines whether this parameter is mandatory.

Example: true

titlestring

The title of the parameter, from 1 to 100 characters range.

Example: Private key

typestring

The type of the parameter.

Example: integer

Possible values: string | integer | boolean

titlestring

The title of the Provider.

Example: Twilio SMS

typestring

The provider type.

Example: sms

Possible values: sms | email | telegram

Default: sms

update_timestring

Timezone: GMT.

Example: 2021-10-30 14:27:26

provider_idstring

The id of the provider. To check for valid provider id's you can list them on the /providers endpoint.

Example: 1000

provider_namestring

The name of the provider. It is inherited from the provider_id.

Example: twilio_sms

settingstwilio-integration

custom-email-integration

mandrill-integration

sendgrid-integration

mitto-integration

mailgun-integration

telegram-integration

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

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

statusstring

The status of the integration. Active integrations can be used to send SMS messages.

Example: active

Possible values: active | inactive

typestring

The type of the integration. It depends on the selected provider type.

Possible values: sms | email | telegram

update_timestring

Timezone: GMT.

Example: 2021-10-30 14:27:26

totalinteger

A total number of items.

Example: 32

tip

1 Sortable fields are: id, name, is_default, create_time and update_time.

2 Searchable fields are: name and logo.

3 Filterable fields are: id, name and type.

Response examples

Copied

200

{
  "total": 1,
  "items": [
    {
      "id": "1000",
      "type": "sms",
      "name": "twilio",
      "title": "Twilio SMS"
      "logo": "https://sm.ocmcore.com/share/4555599/ocamba/apps/hood/integrations/providers/twilio_logo.png",
      "settings": [
        {
          "title": "Account SID",
          "name": "account_sid",
          "type": "string",
          "required": true,
          "deprecated": false
        },
        {
          "title": "Auth Token",
          "name": "auth_token",
          "type": "string",
          "required": true,
          "deprecated": false
        },
        {
          "title": "Default Phone Number",
          "name": "default_phone_number",
          "type": "string",
          "required": true,
          "deprecated": false
        }
      ],
      "create_time": "2024-05-13 10:53:13",
      "update_time": "2024-05-16 11:52:01"
    }
  ]
}

{
  "total": 32,
  "items": [
    {
      "id": "1000",
      "company_id": "1000000",
      "name": "My First Integration",
      "provider_id": "1000",
      "provider_name": "twilio_sms",
      "provider": {
        "id": "1000000",
        "company_id": "1000000",
        "title": "Twilio SMS",
        "name": "twilio",
        "type": "sms",
        "logo": "https://example.com/logo.jpg",
        "settings": [
          {
            "title": "Private key",
            "name": "p_key",
            "type": "integer",
            "required": true,
            "deprecated": true
          }
        ],
        "create_time": "2021-10-29 12:47:00",
        "update_time": "2021-10-30 14:27:26"
      },
      "status": "active",
      "effective_status": "active",
      "is_default": true,
      "create_time": "2021-10-29 12:47:00",
      "update_time": "2021-10-30 14:27:26"
    }
  ]
}

List Providers

GET /providersCopied https://api.ocamba.com/v1/hood/providers

GET /providers
Copied
`https://api.ocamba.com/v1/hood/providers`