To use the Bipio API you will need login credentials which includes an API key. To signup to the Bipio API, please visit us at https://bip.io

For more info, please see the official docs or follow our blog for all the latest and greatest.

Bipio Terms of Service Effective March 12 2013 Acceptance of Terms

IMPORTANT -- READ CAREFULLY: BY CREATING AN ACCOUNT OR BY UTILIZING THE BIPIO SERVICE YOU AGREE TO BE BOUND BY THESE TERMS AND CONDITIONS.

Welcome to the Bipio service ("Service"). Your use of the Service is subject to these Terms of Service. This is a legal agreement ("Agreement") between You and Cloud Spark Pty Ltd ACN 145 428 324 ("CloudSpark"), an Australian Proprietary Limited Company, for use of the Bipio service. "You" refers to any individual who creates an account on the Service, or, if the Service is being used on behalf of an entity by an individual authorized to agree to such terms on behalf of such entity, then "You" refers to such entity. If You do not agree with the terms of this Agreement, do not use the Service. CloudSpark reserves the right to update and change the Agreement from time to time without notice or acceptance by You. The Agreement will also be applicable to the use of the Service on a trial basis. By using the Service, You signify Your irrevocable acceptance of this Agreement.

The website and any downloadable software associated with the Service are protected by copyright laws and international copyright treaties, as well as other intellectual property laws and treaties. Service Description

The Service includes, and is limited to, a web site and Application Programming Interface (API) allowing You access to and use of a single Bipio Account. "Bipio" referred to herein means the CloudSpark Bipio Service, an online tool that links 3rd party API's together for the purpose of non-trivial message transformation and distribution. A "Bipio Account" or "Account" referred to herein means a web site, provided by CloudSpark, where You may use Bipio to create, update, share, and publish information, data, text, messages or other materials ("Content").

Without limiting the foregoing, the Service is not designed or licensed for use in hazardous environments requiring fail-safe controls, including without limitation operation of nuclear facilities, aircraft navigation/communication systems, air traffic control, and life support or weapons systems.

Unless explicitly stated otherwise, any new features that augment or enhance the current Service, including the release of new tools and resources, shall be subject to the Agreement. In order to use the Service, You must obtain access to the World Wide Web, either directly or through devices that access web-based content, and pay any service fees associated with such access. In addition, You must provide all equipment necessary to make such connection to the World Wide Web, including a computer and modem or other access device. You also understand and agree that the service may include certain communications from CloudSpark, such as service announcements, administrative messages, etc., and that these communications are considered part of the Service and You will not be able to opt out of receiving them. You agree not to access the Service by any means other than through the web and API interfaces that are provided and publicly documented by CloudSpark for use in accessing the Service. CloudSpark will provide the Service in accordance with this Agreement. CloudSpark may at its sole discretion modify the features of the Service from time to time without prior notice. Registration

In order to use the Service, You must have a valid Account. To acquire an Account for the Service, You must provide CloudSpark with an electronic mail address and other information ("Registration Data"). You will choose an account designation for Your Account during the Service's registration process. You are responsible for maintaining the confidentiality of the access data for Your Account, and are fully responsible for all activities that occur under Your Account. You agree to (a) immediately notify CloudSpark of any unauthorized use of Your Account or any other breach of security, and (b) ensure that You exit from Your Account at the end of each session. CloudSpark cannot and will not be liable for any loss or damage arising from Your failure to comply with this section. In consideration of use of the Service, You agree to: (a) provide true, accurate, current and complete information about Yourself as prompted by the Service's registration form, and (b) maintain and promptly update the Registration Data to keep it true, accurate, current and complete. CloudSpark assumes no duty to verify such as further detailed in CONTENT OF THE SERVICE. If You provide any information that is untrue, inaccurate, not current or incomplete, or CloudSpark has reasonable grounds to suspect that such information is untrue, inaccurate, not current or incomplete, CloudSpark has the right to suspend or terminate Your Account and refuse any and all current or future use of the Service (or any portion thereof). If You are under 18 years of age then You are required to have a parent or guardian review and complete the registration process on your behalf. If you are under 13 years of age you are not permitted to use this service. Third Party Services

The Service enables communication between various online third-party services ("Third-Party Services"). To take advantage of these feature and capabilities, we may ask you to authenticate, register for or log into Third-Party Services through the Service or on the websites of their respective providers. For more information about the implications of activating these Third-Party Services and CloudSpark's use, storage and disclosure of information related to you and your use of Third-Party Services within Bipio, please see our Privacy Policy at https://bip.io/privacy. However, please remember that the manner in which Third-Party Services use, store and disclose your information is governed solely by the policies of such third parties.

The Service may provide, or third parties may provide, links or other access to other sites and resources on the Internet (including without limitation Third-Party Services). CloudSpark has no control over such sites and resources and is not responsible for and does not endorse such sites and resources. You further acknowledge and agree that CloudSpark will not be responsible or liable, directly or indirectly, for any damage or loss caused or alleged to be caused by or in connection with use of or reliance on any content, events, goods or services available on or through any such site or resource. Any dealings you have with third parties found while using the Service are between You and the Third Party, and you agree that CloudSpark is not liable for any loss or claim that you may have against any such third party.

The Service includes certain services that are available via a mobile device, including the ability to set the Service to communicate within mobile device by telephone call or SMS (collectively, the "Mobile Services"). To the extent you use the Service through a mobile device, your wireless service carrier's standard charges, data rates and other fees may apply. In addition, using Mobile Services may be prohibited or restricted by your carrier, and not all Mobile Services may work with all carriers or devices. In the event you change or deactivate your mobile telephone number, you agree to promptly update your Bipio account information to ensure that your messages are not sent to the person that acquires your old number. Payments

To the extent the Service or any portion thereof is made available for any fee, you will be required to select a payment plan and provide CloudSpark information regarding your preferred payment instrument. You represent and warrant to CloudSpark that such information is true and that you are authorized to use the payment instrument. You will promptly update your account information with any changes (for example, a change in your billing address or credit card expiration date) that may occur. You agree to pay CloudSpark the amount that is specified in the payment plan in accordance with the terms of such plan and this TOS. You hereby authorize CloudSpark to bill your payment instrument in advance on a periodic basis in accordance with the terms of the applicable payment plan until you terminate your account, and you further agree to pay any charges so incurred. If you dispute any charges you must let CloudSpark know within sixty (60) days after the date that CloudSpark bills you. We reserve the right to change Bipio's prices. If CloudSpark does and you are on active payment plan, you will have the option to continue using CloudSpark at the previous price. You may upgrade or downgrade plans at any time, with the balance of a downgrade being credited prorata to the following month. Termination, Breach, Suspension and Cancellation

CloudSpark may, at its sole discretion, at any time and for any reason, terminate the Service, terminate this Agreement, or suspend or terminate Your Account. In the event of suspension or termination, Your account will be disabled and You may not be granted access to Your Account or any files or other Content contained in Your Account, and CloudSpark may delete Your Content, although residual copies of information may remain in our system for some time for back-up purposes. In the event of termination, CloudSpark may also withdraw and at its discretion reallocate the public web address of Your Account.

If You terminate Your Account, via means provided for cancellation on the CloudSpark website or in Your Account, or via electronic mail to CloudSpark, and You request that CloudSpark delete Content and files contained in Your Account, CloudSpark will make all reasonable efforts to do so. Proprietary/Intellectual Property Rights

CloudSpark and/or its suppliers, as applicable, retain ownership of all proprietary rights in the Service and in all trade names, trademarks and service marks associated or displayed with the Service. You will not remove, deface or obscure any of CloudSpark's or its suppliers' copyright or trademark notices and/or legends or other proprietary notices on, incorporated therein, or associated with the Service. You may not reverse engineer, reverse compile or otherwise reduce to human readable form any software associated with the Service. Injunctive Relief

You acknowledge that any use of the Service contrary to this Agreement, or any transfer, sublicensing, copying or disclosure of technical information or materials related to the Service, may cause irreparable injury to CloudSpark, its affiliates, suppliers and any other party authorized by CloudSpark to resell, distribute, or promote the Service ("Resellers"), and under such circumstances CloudSpark, its affiliates, suppliers and Resellers will be entitled to equitable relief, without posting bond or other security, including, but not limited to, preliminary and permanent injunctive relief. Proper Use

You understand that all Content are the sole responsibility of the person from which such Content originated. This means that You, and not CloudSpark, are entirely responsible for all Content that You upload, post, transmit or otherwise make available via Your Account. CloudSpark does not control the Content posted via the Service and, as such, does not guarantee the accuracy, integrity or quality of such Content.

You understand that by using the Service, You may be exposed to Content that You find offensive. Under no circumstances will CloudSpark be liable in any way for any Content, including, but not limited to, for any errors or omissions in any Content, or for any loss or damage of any kind incurred as a result of the use of any Content posted, transmitted or otherwise made available via the Service. You acknowledge that CloudSpark does not pre-screen Content, but that CloudSpark and its designees shall have the right (but not the obligation) in their sole discretion to refuse or move any Content that is available via the Service. Without limiting the foregoing, CloudSpark and its designees shall have the right to remove any Content that violates the Agreement. You agree that You must evaluate, and bear all risks associated with, the use of any Content, including any reliance on the accuracy, completeness, or usefulness of such Content. In this regard, You acknowledge that You may not reasonably rely on any Content created by Bipio or submitted to Bipio. You acknowledge and agree that CloudSpark may preserve Content and may also disclose Content if required to do so by law or in the good faith belief that such preservation or disclosure is reasonably necessary to: (a) comply with legal process; (b) enforce the Agreement; (c) respond to claims that any Content violates the rights of third-parties; or (d) protect the rights, property, or personal safety of CloudSpark, its users and the public.

You understand that the technical processing and transmission of the Service, including Your Content, may involve (a) transmissions over various networks; and (b) changes to conform and adapt to technical requirements of connecting networks, external API's or devices.

Should Content be found or reported to be in violation with, but not limited to, the following terms, it will be in CloudSpark's sole discretion as to what action should be taken. You agree that You will not:

(a) upload, post, transmit or otherwise make available any Content that is unlawful, harmful, threatening, abusive, harassing, tortuous, defamatory, vulgar, obscene, libelous, invasive of another's privacy (up to, but not excluding any address, email, phone number, or any other contact information without the written consent of the owner of such information), hateful, or racially, ethnically or otherwise objectionable;

(b) harm minors in any way;

(c) impersonate any person or entity, including, but not limited to, a CloudSpark official, forum leader, guide or host, or falsely state or otherwise misrepresent Your affiliation with a person or entity;

(d) forge headers or otherwise manipulate identifiers in order to disguise the origin of any Content transmitted through the Service;

(e) upload, post or otherwise transmit any Content that You do not have a right to transmit under any law or under contractual or fiduciary relationships (such as inside information, proprietary and confidential information learned or disclosed as part of employment relationships or under nondisclosure agreements);

(f) upload, post or otherwise transmit any Content that infringes any patent, trademark, trade secret, copyright, rights of privacy or publicity, or other proprietary rights of any party;

(g) upload, post, or transmit unsolicited commercial email or "spam". This includes unethical marketing, advertising, or any other practice that is in any way connected with "spam", including but not limited to (a) sending mass email to recipients who haven't requested email from You or with a fake return address, (b) promoting a site with inappropriate links, titles, descriptions, or (c) promoting Your site by posting multiple submissions in public forums that are identical;

(h) upload, post or otherwise transmit any material that contains software viruses or any other computer code, files or programs designed to interrupt, destroy or limit the functionality of any computer software or hardware or telecommunications equipment;

(i) interfere with or disrupt the Service or servers or networks connected to the Service, or disobey any requirements, procedures, policies or regulations of networks connected to the Service;

(j) "stalk" or otherwise harass another;

(k) promote or provide instructional information about illegal activities, promote physical harm or injury against any group or individual, or promote any act of cruelty. This may include, without limitation, providing instructions on how to assemble bombs, grenades and other weapons or incendiary devices.

(l) offer for sale or sell any item, good or service that (a) violates any applicable federal, state, or local law or regulation, (b) You do not have full power and authority under all relevant laws and regulations to offer and sell, including all necessary licenses and authorizations, or (c) CloudSpark determines, in its sole discretion, is inappropriate for sale through the Service provided by CloudSpark;

(m) exceed the scope of the Service that You have signed up for; for example, accessing and using the tools that You do not have a right to use, or having humans share User logins, or deleting, adding to, or otherwise changing other people's comments or content as an Account holder. If any user is reported to be in violation with the letter or spirit of these terms, CloudSpark retains the right to terminate such account at any time without further warning. General Practices Regarding Use and Storage

You agree that CloudSpark has no responsibility or liability for the deletion of, or the failure to store or to transmit, any Content and other communications maintained by the Service. You acknowledge that CloudSpark may establish general practices and limits concerning use of the Service and may modify such practices and limits from time to time. CloudSpark retains the right to create limits on use and storage at our sole discretion at any time with or without notice. You acknowledge that Bipio reserve the right to log off users automatically or by manual intervention who are inactive for 1 year.

You agree that You will not:

(a) upload, post, email, or otherwise transmit any computer routines, files or programs designed to interrupt, destroy or limit the functionality of any computer software or hardware or telecommunications equipment;

(b) interfere with or disrupt our Service or networks connected to our website or through the use of our Service, or disobey any requirements, procedures, policies or regulations of networks connected to our website or through the use of our Service, or otherwise interfere with our Service in any way, including through the use of JavaScript, ActiveX or other coding;

(c) take any action that imposes an unreasonable or disproportionately large load on our infrastructure; or

(d) copy, reproduce, alter, modify, or publicly display any information displayed on our website (except for Your Information), or create derivative works from our website (other than from Your Information), to the extent that such action(s) would constitute copyright infringement or otherwise violate the intellectual property rights of CloudSpark or any other third party, except with the prior written consent of CloudSpark or the appropriate third party. Content of The Service

CloudSpark takes no responsibility for third-party content (including, without limitation,any viruses or other disabling features), nor does CloudSpark have any obligation to monitor such third-party content. CloudSpark reserves the right at all times to remove or refuse to distribute any content on the Service, such as content which violates the terms of this Agreement. CloudSpark also reserves the right to access, read, preserve, and disclose any information as it reasonably believes is necessary to (a) satisfy any applicable law, regulation, legal process or governmental request, (b) enforce this Agreement, including investigation of potential violations hereof, (c) detect, prevent, or otherwise address fraud, security or technical issues, (d) respond to user support requests, or (e) protect the rights, property or safety of CloudSpark, its users and the public. CloudSpark will not be responsible or liable for the exercise or non-exercise of its rights under this Agreement. International Use

Recognizing the global nature of the Internet, You agree to comply with all local rules regarding online conduct and acceptable Content. Specifically, You agree to comply with all applicable laws regarding the transmission of technical data exported from the United States or the country in which You reside. Resale of The Service

You agree not to reproduce, duplicate, copy, sell, resell or exploit any portion of the Service, use of the Service, or access to the Service without the express permission by CloudSpark. Indemnity

You agree to indemnify, defend and hold harmless CloudSpark, its affiliates, officers, directors, employees, consultants, agents, suppliers and Resellers from any and all third party claims, liability, damages and/or costs (including, but not limited to, attorneys fees as and when incurred) arising from Your use of the Service, Your use of Your Account, Your violation of this Agreement or the infringement or violation by You or any other User of Your Account, of any intellectual property or other right of any person or entity. Service Modifications

CloudSpark reserves the right at any time and from time to time to modify or discontinue, temporarily or permanently, the Service (or any part thereof) with or without notice at any time. You agree that CloudSpark shall not be liable to You or to any third party for any modification, suspension, termination or discontinuance of the Service. No Agency

No agency, partnership, joint venture, employee-employer or franchiser-franchisee relationship between You and CloudSpark is intended or created by this Agreement. Waiver And Severability

Failure by either party to exercise any of its rights under, or to enforce any provision of, this Agreement will not be deemed a waiver or forfeiture of such rights or ability to enforce such provision. If any provision of this Agreement is held by a court of competent jurisdiction to be illegal, invalid or unenforceable, that provision will be amended to achieve as nearly as possible the same economic effect of the original provision and the remainder of this Agreement will remain in full force and effect. Statute Of Limitations

You agree that regardless of any statute or law to the contrary, any claim or cause of action arising of or related to use of CloudSpark services or the Terms of Service must be filed within one (1) year after such claim or cause of action arose or be forever barred. Warranty

THE SERVICE, INCLUDING THE SITE AND CONTENT, AND ALL SERVER AND NETWORK COMPONENTS ARE PROVIDED ON AN "AS IS" AND "AS AVAILABLE" BASIS WITHOUT ANY WARRANTIES OF ANY KIND, AND CLOUD SPARK EXPRESSLY DISCLAIMS ANY AND ALL WARRANTIES, WHETHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, TITLE, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT. YOU ACKNOWLEDGE THAT CLOUD SPARK DOES NOT WARRANT THAT THE SERVICE WILL BE UNINTERRUPTED, TIMELY, SECURE, ERROR-FREE OR VIRUS-FREE AND NO INFORMATION, ADVICE OR SERVICES OBTAINED BY YOU FROM CLOUD SPARK OR THROUGH THE SERVICE SHALL CREATE ANY WARRANTY NOT EXPRESSLY STATED IN THIS TOS.

You represent and warrant that (a) all of the information provided by You to CloudSpark to participate in the Service is correct and current; and (b) You have all necessary right, power and authority to enter into this Agreement and to perform the acts required of You hereunder. Limitation Of Liability

UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL THEORY (WHETHER IN CONTRACT, TORT, OR OTHERWISE) SHALL CLOUD SPARK BE LIABLE TO YOU OR ANY THIRD PARTY FOR (A) ANY INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, CONSEQUENTIAL OR PUNITIVE DAMAGES, INCLUDING LOST PROFITS, LOST SALES OR BUSINESS, LOST DATA OR BUSINESS INTERRUPTION, OR (B) FOR ANY DIRECT DAMAGES, COSTS, LOSSES OR LIABILITIES IN EXCESS OF THE FEES ACTUALLY PAID BY YOU IN THE SIX (6) MONTHS PRECEDING THE EVENT GIVING RISE to YOUR CLAIM or, IF NO FEES APPLY, ONE HUNDRED ($100) Australian Dollars. THE PROVISIONS OF THIS SECTION ALLOCATE THE RISKS UNDER THIS TOS BETWEEN THE PARTIES, AND THE PARTIES HAVE RELIED ON THESE LIMITATIONS IN DETERMINING WHETHER TO ENTER INTO THIS TOS. Choice of Law And Forum

This Agreement shall be governed by and construed under the laws of the State of Victoria, Australia, as applied to agreements entered into and to be performed in Victoria by Victorian residents. The parties consent to the exclusive jurisdiction and venue of the courts located in and serving the City of Melbourne in the State of Victoria, Australia. Agreement and General Provisions

This Agreement embodies the entire understanding and agreement between the parties respecting the subject matter of this Agreement and supersedes any and all prior understandings and agreements between the parties respecting such subject matter. CloudSpark may change the terms of this Agreement at any time by posting modified terms on its website. This Agreement has been prepared in the English Language and such version shall be controlling in all respects and any non-English version of this Agreement is solely for accommodation purposes. Any and all rights and remedies of CloudSpark upon Your breach or other default under this Agreement will be deemed cumulative and not exclusive of any other right or remedy conferred by this Agreement or by law or equity on CloudSpark, and the exercise of any one remedy will not preclude the exercise of any other. The captions and headings appearing in this Agreement are for reference only and will not be considered in construing this Agreement. Notices to You may be made via either email or regular mail. The Service may also provide notices of changes to the Agreement or other matters by displaying notices or links to notices to You generally on the Service.

Last 7 days, UTC

Average Latency
294ms

Average Uptime
100.0%

Current Status
Online

  • No information
  • Outage
  • Disruption
  • Normal
Average latency determined from Mashape to API Response time
Basic Authentication
 

Username is your bip.io username, the password token can be found in your account settings at https://bip.io


Authentication
Description
Parameter
String

HTTP basic username

Username

Required

String

HTTP basic password

Password

Bip

HTTP 200 : transform POST/rest/bip
Transforms are Hub components for mapping the exports and imports between adjacent Channels on a Hub. They're a key/value collection where key is the source export, and value is the target import. Exports can be literal imports or interpolated into templates, of the form [% attribute %]. Template variables can be derived from any available export.
						transforms : {    
    'ba63c4c8-e168-4935-a1cc-a59b1cffed0d' : {
        "from" : "reply_to"
        "cf01c8ec-e542-46ce-9895-74b6ea3fcf5b.mail_from" : "rcpt_to"
        "Hi there [% name %] we got your email via [% _bip#name %] from IP [% _client#host %]" : "subject"
    }
}						
Create Bip

Request Body

HTTP 200 : string DELETE/rest/bip/{id}
Delete Bip

Test console
Description
Parameter
string

UUID
Example: 558abc38-b655-11e1-9983-e1b3de3e9b4d

id

Required

HTTP 200 : bip GET/rest/bip/{id}
A Bip is a very fast and light weight endpoint definition for your personal domain(s) that receives and processes messages. It contains an endpoint type, a unique name, and a delivery strategy. The delivery strategy is a graph of Channels, or more simply, a Hub.
						{
    id: "bc928113-0a98-4975-a821-98373aa72551",
    name: "test",
    domain_id: "31b3a2db-4ea4-d1c8-b35d-00004d00b4d7",
    type: "smtp",
    config: { },
    hub: {
        source: {
            edges: [
                "05de2c02-7ec6-4be8-d3db-00006a8ed73e"
                ]
            }
    },
    note: "sample smtp bip",
    end_life: {
        time: 0,
        imp: 0
    },
    paused: false,
    icon: ""
}						
Retrieve Bip

Test console
Description
Parameter
string

UUID
Example: 558abc38-b655-11e1-9983-e1b3de3e9b4d

id

Required

HTTP 200 : bip GET/rest/bip
A Bip is a very fast and light weight endpoint definition for your personal domain(s) that receives and processes messages. It contains an endpoint type, a unique name, and a delivery strategy. The delivery strategy is a graph of Channels, or more simply, a Hub.
						{
    id: "bc928113-0a98-4975-a821-98373aa72551",
    name: "test",
    domain_id: "31b3a2db-4ea4-d1c8-b35d-00004d00b4d7",
    type: "smtp",
    config: { },
    hub: {
        source: {
            edges: [
                "05de2c02-7ec6-4be8-d3db-00006a8ed73e"
                ]
            }
    },
    note: "sample smtp bip",
    end_life: {
        time: 0,
        imp: 0
    },
    paused: false,
    icon: ""
}						
Retrieve list of Bips

Test console
Description
Parameter
number

Number of results to return. (Default 10)
Example: 10

page_size

Optional

number

Page Number (default 1)
Example: 1

page

Optional

string

Order by 'recent', 'active', 'alphabetical' (default 'recent')

order_by

Optional

HTTP 200 : transform PUT/rest/bip
Transforms are Hub components for mapping the exports and imports between adjacent Channels on a Hub. They're a key/value collection where key is the source export, and value is the target import. Exports can be literal imports or interpolated into templates, of the form [% attribute %]. Template variables can be derived from any available export.
						transforms : {    
    'ba63c4c8-e168-4935-a1cc-a59b1cffed0d' : {
        "from" : "reply_to"
        "cf01c8ec-e542-46ce-9895-74b6ea3fcf5b.mail_from" : "rcpt_to"
        "Hi there [% name %] we got your email via [% _bip#name %] from IP [% _client#host %]" : "subject"
    }
}						
Update Bip

Request Body

Channel

HTTP 200 : channel POST/rest/channel
A Channel consumes and produces a message, and performs a specific function. The ecosystem of Channels you create becomes the swatch from which Bips are made. The two are symbiotic. Without Bips, Channels do nothing. Without Channels, Bips can't exist. Use as many or as few of them as you like. Channels can be derived from containers called Pods. Pods only provide a template from which a Channel can be configured, they're not a RESTful resource, but just Bipio's way of organizing similar actions in an intuitive way.
						{
  "id": "02277c76-33e1-b6c8-c28a-000008a737b4",
  "name": "Personal Inbox",
  "action": "email.smtp_forward",
  "config": {
    "rcpt_to": "foo@bar.com"
  },
  "note": "Forwards Email to my personal inbox",
  "_repr": "foo@bar.com",
}						
Create Channel

Creates a new Channel instance from a Pod Action


Request Body

HTTP 200 : transform DELETE/rest/channel/{id}
Transforms are Hub components for mapping the exports and imports between adjacent Channels on a Hub. They're a key/value collection where key is the source export, and value is the target import. Exports can be literal imports or interpolated into templates, of the form [% attribute %]. Template variables can be derived from any available export.
						transforms : {    
    'ba63c4c8-e168-4935-a1cc-a59b1cffed0d' : {
        "from" : "reply_to"
        "cf01c8ec-e542-46ce-9895-74b6ea3fcf5b.mail_from" : "rcpt_to"
        "Hi there [% name %] we got your email via [% _bip#name %] from IP [% _client#host %]" : "subject"
    }
}						
Delete Channel

Deletes a Channel which has no adjacent Channels, Bips or Triggers


Test console
Description
Parameter
string

Channel Id
Example: 02277c76-33e1-b6c8-c28a-000008a737b4

id

Required

HTTP 200 : channel GET/rest/channel/{id}
A Channel consumes and produces a message, and performs a specific function. The ecosystem of Channels you create becomes the swatch from which Bips are made. The two are symbiotic. Without Bips, Channels do nothing. Without Channels, Bips can't exist. Use as many or as few of them as you like. Channels can be derived from containers called Pods. Pods only provide a template from which a Channel can be configured, they're not a RESTful resource, but just Bipio's way of organizing similar actions in an intuitive way.
						{
  "id": "02277c76-33e1-b6c8-c28a-000008a737b4",
  "name": "Personal Inbox",
  "action": "email.smtp_forward",
  "config": {
    "rcpt_to": "foo@bar.com"
  },
  "note": "Forwards Email to my personal inbox",
  "_repr": "foo@bar.com",
}						
Retrieve Channel

Retrieves a Channel by Id


Test console
Description
Parameter
string

Channel Id
Example: 558abc38-b655-11e1-9983-e1b3de3e9b4d

id

Required

HTTP 200 : channel GET/rest/channel
A Channel consumes and produces a message, and performs a specific function. The ecosystem of Channels you create becomes the swatch from which Bips are made. The two are symbiotic. Without Bips, Channels do nothing. Without Channels, Bips can't exist. Use as many or as few of them as you like. Channels can be derived from containers called Pods. Pods only provide a template from which a Channel can be configured, they're not a RESTful resource, but just Bipio's way of organizing similar actions in an intuitive way.
						[{
  "id": "02277c76-33e1-b6c8-c28a-000008a737b4",
  "name": "Personal Inbox",
  "action": "email.smtp_forward",
  "config": {
    "rcpt_to": "foo@bar.com"
  },
  "note": "Forwards Email to my personal inbox",
  "_repr": "foo@bar.com",
}]						
Retrieve list of Channels

Test console
Description
Parameter
number

Number of results to return. (Default 10)
Example: 10

page_size

Optional

number

Page Number (default 1)
Example: 1

page

Required

HTTP 200 : channel PUT/rest/channel
A Channel consumes and produces a message, and performs a specific function. The ecosystem of Channels you create becomes the swatch from which Bips are made. The two are symbiotic. Without Bips, Channels do nothing. Without Channels, Bips can't exist. Use as many or as few of them as you like. Channels can be derived from containers called Pods. Pods only provide a template from which a Channel can be configured, they're not a RESTful resource, but just Bipio's way of organizing similar actions in an intuitive way.
						{
  "id": "02277c76-33e1-b6c8-c28a-000008a737b4",
  "name": "Personal Inbox",
  "action": "email.smtp_forward",
  "config": {
    "rcpt_to": "foo@bar.com"
  },
  "note": "Forwards Email to my personal inbox",
  "_repr": "foo@bar.com",
}						
Update Channel

Request Body

Domain

HTTP 200 : transform POST/rest/domain
Transforms are Hub components for mapping the exports and imports between adjacent Channels on a Hub. They're a key/value collection where key is the source export, and value is the target import. Exports can be literal imports or interpolated into templates, of the form [% attribute %]. Template variables can be derived from any available export.
						transforms : {    
    'ba63c4c8-e168-4935-a1cc-a59b1cffed0d' : {
        "from" : "reply_to"
        "cf01c8ec-e542-46ce-9895-74b6ea3fcf5b.mail_from" : "rcpt_to"
        "Hi there [% name %] we got your email via [% _bip#name %] from IP [% _client#host %]" : "subject"
    }
}						
Create Domain

Request Body

  • string

    HTTP 0
HTTP 200 : string DELETE/rest/domain/{id}
Delete a Domain

**Note: System generated domains, such as {username}.bip.io are immutable


Test console
Description
Parameter
string

Domain UUID
Example: 000000c3-0000-4ac2-8000-e49b00009d91

id

Required

  • string

    HTTP 0
HTTP 200 : domain GET/rest/domain/{id}
Custom domains (FQDN's) can be added dynamically and will serve content as long as the domain is unique in the system and its DNS resolves to CNAME {username}.bip.io. The id returned can be used to attach bips to specific domains.
						{
  "id": "28c84e82-bbd6-11e1-8af1-a639281e1f41",
  "name": "foo.net"
}						
Retrieve a Domain

Test console
Description
Parameter
string

Domain UUID
Example: 000000c3-0000-4ac2-8000-e49b00009d91

id

Required

HTTP 200 : string GET/rest/domain
Retrieve list of Domains

Test console
Description
Parameter
string

Number of results to return. (Default 10)
Example: 10

page_size

Optional

REST Generic

HTTP 200 : collection GET/rest/{model_name}
resource collection, including pagination metadata
						{
  "data": [
    {
      "id": "8a962b23-9131-45d7-9ce6-fdcaa904e2b2",
      "name": "hipchat",
      "domain_id": "664616d3-5caf-ab09-b398-000012b5e920",
      "type": "smtp",
      "deliver_to": [
        {
          "transform": "system",
          "channel_id": "23bb1de5-c950-c448-fbbf-000056c1eed7"
        }
      ],
      "note": "via www.hipchat.com",
      "end_life": {
        "time": 1354424400,
        "imp": 0
      },
      "icon": "https://hipchat.com/favicon.ico",
      "owner_id": "40455d3b-1cd3-0b08-9374-000010be365f",
      "created": "1354406451383",
      "repr": "hipchat@doctest.bip.io"
    },
    {
      "id": "ddef0e2a-3a13-4ee6-8143-48132c5cbb51",
      "name": "soundcloud",
      "domain_id": "664616d3-5caf-ab09-b398-000012b5e920",
      "type": "smtp",
      "deliver_to": [
        {
          "transform": "system",
          "channel_id": "23bb1de5-c950-c448-fbbf-000056c1eed7"
        }
      ],
      "note": "via soundcloud.com",
      "end_life": {
        "time": 1353992400,
        "imp": 0
      },
      "icon": "http://soundcloud.com/favicon.ico",
      "owner_id": "40455d3b-1cd3-0b08-9374-000010be365f",
      "created": "1353995734331",
      "repr": "soundcloud@doctest.bip.io"
    }
  ],
  "page": 1,
  "page_size": 10,
  "order_by": "recent"
}						
List Collection

Retrieve a collection of models, including pagination metadata


Test console
Description
Parameter
string

Model Context
Example: bip

model_name

Required

number

Number of results to return. (Default 10)
Example: 10

page_size

Optional

number

Page Number (default 1)

page

Optional

string

Order by 'recent', 'active', 'alphabetical' (default 'recent')
Example: active

order_by

Optional

RPC

HTTP 200 : transform POST/rpc/create_from_referer
Transforms are Hub components for mapping the exports and imports between adjacent Channels on a Hub. They're a key/value collection where key is the source export, and value is the target import. Exports can be literal imports or interpolated into templates, of the form [% attribute %]. Template variables can be derived from any available export.
						transforms : {    
    'ba63c4c8-e168-4935-a1cc-a59b1cffed0d' : {
        "from" : "reply_to"
        "cf01c8ec-e542-46ce-9895-74b6ea3fcf5b.mail_from" : "rcpt_to"
        "Hi there [% name %] we got your email via [% _bip#name %] from IP [% _client#host %]" : "subject"
    }
}						
Create from Referer

Create a named Bip from referer URI with default settings


Test console
Description
Parameter
string

Valid URI schema + path (eg: http://domain.com, mailto:foo@bar.com etc)
Example: http://developers.chrome.com

referer

Required

HTTP 200 : referer hint GET/rpc/get_referer_hint
						{
  "hint": "startuply"
}						
Get Referer Hint

Derives a Bip model 'name' attribute hint from the (http/smtp) referer


Test console
Description
Parameter
string

Email address or URI. Where not defined, will attempt to use HTTP Referer header instead.

referer

Optional

Consume this API completely for free!


By joining the mashape API marketplace you can start using bipio API today!

Login to your account or signup: Create Account

or
   Signup with GitHub

By signing up you agree to our terms of service.