Register Domain with OpenSRS API on New Requests (Payload Only) from HTTP / Webhook API

Pipedream makes it easy to connect APIs for OpenSRS, HTTP / Webhook and 2,900+ other apps remarkably fast.

Trigger workflow on

New Requests (Payload Only) from the HTTP / Webhook API

Next, do this

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a HTTP / Webhook trigger and OpenSRS action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Requests (Payload Only) trigger
1. Connect your HTTP / Webhook account
Configure the Register Domain action
1. Connect your OpenSRS account
2. Configure Domain
3. Configure Reseller Username
4. Configure Reseller Password
5. Configure Owner First Name
6. Configure Owner Last Name
7. Configure Owner Email
8. Optional- Configure Owner Organization Name
9. Configure Owner Phone
10. Configure Owner Address 1
11. Configure Owner City
12. Configure Owner Country
13. Configure Owner State
14. Configure Owner Postal Code
15. Configure Admin First Name
16. Configure Admin Last Name
17. Configure Admin Email
18. Optional- Configure Admin Organization Name
19. Configure Admin Phone
20. Configure Admin Address 1
21. Configure Admin City
22. Configure Admin Country
23. Configure Admin State
24. Configure Admin Postal Code
25. Configure Billing First Name
26. Configure Billing Last Name
27. Configure Billing Email
28. Optional- Configure Billing Organization Name
29. Configure Billing Phone
30. Configure Billing Address 1
31. Configure Billing City
32. Configure Billing Country
33. Configure Billing State
34. Configure Billing Postal Code
35. Configure Tech First Name
36. Configure Tech Last Name
37. Configure Tech Email
38. Optional- Configure Tech Organization Name
39. Configure Tech Phone
40. Configure Tech Address 1
41. Configure Tech City
42. Configure Tech Country
43. Configure Tech State
44. Configure Tech Postal Code
45. Select a Custom Tech Contact
46. Optional- Select a Auto Renew
47. Select a Period
48. Select a Custom Nameservers
49. Optional- Configure JSON Output
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Requests (Payload Only) on HTTP / Webhook

Description:Get a URL and emit the HTTP body as an event on every request

Version:0.1.1

Key:http-new-requests-payload-only

View on GitHub

HTTP / Webhook Overview#

Build, test, and send HTTP requests without code using your Pipedream workflows. The HTTP / Webhook action is a tool to build HTTP requests with a Postman-like graphical interface.

Point and click HTTP requests

Define the target URL, HTTP verb, headers, query parameters, and payload body without writing custom code.

$A screenshot of Pipedream's HTTP Request Configuration interface with a GET request type selected. The request URL is set to 'https://api.openai.com/v1/models'. The 'Auth' tab is highlighted, indicating that authentication is required for this request. In the headers section, there are two headers configured: 'User-Agent' is set to 'pipedream/1', and 'Authorization' is set to 'Bearer {{openai_api_key}}', showing how the OpenAI account's API key is dynamically inserted into the headers to handle authentication automatically.$

Here's an example workflow that uses the HTTP / Webhook action to send an authenticated API request to OpenAI.

Focus on integrating, not authenticating

This action can also use your connected accounts with third-party APIs. Selecting an integrated app will automatically update the request’s headers to authenticate with the app properly, and even inject your token dynamically.

Pipedream integrates with thousands of APIs, but if you can’t find a Pipedream integration simply use Environment Variables in your request headers to authenticate with.

Compatible with no code actions or Node.js and Python

The HTTP/Webhook action exports HTTP response data for use in subsequent workflow steps, enabling easy data transformation, further API calls, database storage, and more.

Response data is available for both coded (Node.js, Python) and no-code steps within your workflow.

Trigger Code#

import http from "../../http.app.mjs";

// Core HTTP component
// Returns a 200 OK response, emits the HTTP payload as an event
export default {
  key: "http-new-requests-payload-only",
  name: "New Requests (Payload Only)",
  // eslint-disable-next-line
  description: "Get a URL and emit the HTTP body as an event on every request",
  version: "0.1.1",
  type: "source",
  props: {
    // eslint-disable-next-line
    httpInterface: {
      type: "$.interface.http",
      customResponse: true,
    },
    http,
  },
  async run(event) {
    const { body } = event;
    this.httpInterface.respond({
      status: 200,
      body,
    });
    // Emit the HTTP payload
    this.$emit({
      body,
    });
  },
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
N/A	`httpInterface`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
HTTP / Webhook	`http`	`app`	This component uses the HTTP / Webhook app.

Trigger Authentication#

The HTTP / Webhook API does not require authentication.

About HTTP / Webhook#

Get a unique URL where you can send HTTP or webhook requests

Action#

Description:Register a new domain. [See the documentation](https://domains.opensrs.guide/docs/sw_register-domain-or-trust_service-).

Version:0.0.2

Key:opensrs-register-domain

View on GitHub

Action Code#

import app from "../../opensrs.app.mjs";
import constants from "../../common/constants.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "opensrs-register-domain",
  name: "Register Domain",
  description: "Register a new domain. [See the documentation](https://domains.opensrs.guide/docs/sw_register-domain-or-trust_service-).",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    app,
    domain: {
      propDefinition: [
        app,
        "domain",
      ],
    },
    regUsername: {
      type: "string",
      label: "Reseller Username",
      description: "Usernames must be 3-20 characters in length. You can use any of the following alphanumeric characters: `A-Z`, `a-z`, `0-9`.",
    },
    regPassword: {
      type: "string",
      label: "Reseller Password",
      description: "Passwords must be 10-20 characters in length. You can use any of the following alphanumeric characters and symbols: `A-Z`, `a-z`, `0-9`, `! @$^,.~|=-+_{}#`.",
    },
    ownerFirstName: {
      type: "string",
      label: "Owner First Name",
      description: "The first name of the owner of the domain.",
    },
    ownerLastName: {
      type: "string",
      label: "Owner Last Name",
      description: "The last name of the owner of the domain.",
    },
    ownerEmail: {
      type: "string",
      label: "Owner Email",
      description: "The email of the owner of the domain.",
    },
    ownerOrgName: {
      type: "string",
      label: "Owner Organization Name",
      description: "The organization name of the owner of the domain.",
      optional: true,
    },
    ownerPhone: {
      type: "string",
      label: "Owner Phone",
      description: "The phone number of the owner of the domain.",
    },
    ownerAddress1: {
      type: "string",
      label: "Owner Address 1",
      description: "The first line of the address of the owner of the domain.",
    },
    ownerCity: {
      type: "string",
      label: "Owner City",
      description: "The city of the owner of the domain.",
    },
    ownerCountry: {
      type: "string",
      label: "Owner Country",
      description: "The country of the owner of the domain.",
    },
    ownerState: {
      type: "string",
      label: "Owner State",
      description: "The state of the owner of the domain.",
    },
    ownerPostalCode: {
      type: "string",
      label: "Owner Postal Code",
      description: "The postal code of the owner of the domain.",
    },
    adminFirstName: {
      type: "string",
      label: "Admin First Name",
      description: "The first name of the admin of the domain.",
    },
    adminLastName: {
      type: "string",
      label: "Admin Last Name",
      description: "The last name of the admin of the domain.",
    },
    adminEmail: {
      type: "string",
      label: "Admin Email",
      description: "The email of the admin of the domain.",
    },
    adminOrgName: {
      type: "string",
      label: "Admin Organization Name",
      description: "The organization name of the admin of the domain.",
      optional: true,
    },
    adminPhone: {
      type: "string",
      label: "Admin Phone",
      description: "The phone number of the admin of the domain.",
    },
    adminAddress1: {
      type: "string",
      label: "Admin Address 1",
      description: "The first line of the address of the admin of the domain.",
    },
    adminCity: {
      type: "string",
      label: "Admin City",
      description: "The city of the admin of the domain.",
    },
    adminCountry: {
      type: "string",
      label: "Admin Country",
      description: "The country of the admin of the domain.",
    },
    adminState: {
      type: "string",
      label: "Admin State",
      description: "The state of the admin of the domain.",
    },
    adminPostalCode: {
      type: "string",
      label: "Admin Postal Code",
      description: "The postal code of the admin of the domain.",
    },
    billingFirstName: {
      type: "string",
      label: "Billing First Name",
      description: "The first name of the billing contact of the domain.",
    },
    billingLastName: {
      type: "string",
      label: "Billing Last Name",
      description: "The last name of the billing contact of the domain.",
    },
    billingEmail: {
      type: "string",
      label: "Billing Email",
      description: "The email of the billing contact of the domain.",
    },
    billingOrgName: {
      type: "string",
      label: "Billing Organization Name",
      description: "The organization name of the billing contact of the domain.",
      optional: true,
    },
    billingPhone: {
      type: "string",
      label: "Billing Phone",
      description: "The phone number of the billing contact of the domain.",
    },
    billingAddress1: {
      type: "string",
      label: "Billing Address 1",
      description: "The first line of the address of the billing contact of the domain.",
    },
    billingCity: {
      type: "string",
      label: "Billing City",
      description: "The city of the billing contact of the domain.",
    },
    billingCountry: {
      type: "string",
      label: "Billing Country",
      description: "The country of the billing contact of the domain.",
    },
    billingState: {
      type: "string",
      label: "Billing State",
      description: "The state of the billing contact of the domain.",
    },
    billingPostalCode: {
      type: "string",
      label: "Billing Postal Code",
      description: "The postal code of the billing contact of the domain.",
    },
    techFirstName: {
      type: "string",
      label: "Tech First Name",
      description: "The first name of the tech contact of the domain.",
    },
    techLastName: {
      type: "string",
      label: "Tech Last Name",
      description: "The last name of the tech contact of the domain.",
    },
    techEmail: {
      type: "string",
      label: "Tech Email",
      description: "The email of the tech contact of the domain.",
    },
    techOrgName: {
      type: "string",
      label: "Tech Organization Name",
      description: "The organization name of the tech contact of the domain.",
      optional: true,
    },
    techPhone: {
      type: "string",
      label: "Tech Phone",
      description: "The phone number of the tech contact of the domain.",
    },
    techAddress1: {
      type: "string",
      label: "Tech Address 1",
      description: "The first line of the address of the tech contact of the domain.",
    },
    techCity: {
      type: "string",
      label: "Tech City",
      description: "The city of the tech contact of the domain.",
    },
    techCountry: {
      type: "string",
      label: "Tech Country",
      description: "The country of the tech contact of the domain.",
    },
    techState: {
      type: "string",
      label: "Tech State",
      description: "The state of the tech contact of the domain.",
    },
    techPostalCode: {
      type: "string",
      label: "Tech Postal Code",
      description: "The postal code of the tech contact of the domain.",
    },
    customTechContact: {
      type: "string",
      label: "Custom Tech Contact",
      description: "An indication of whether to use the RSP's tech contact info, or the tech contact info provided n the request.",
      default: "0",
      options: [
        {
          label: "Use reseller's tech contact info.",
          value: "0",
        },
        {
          label: "Use tech contact info provided in request.",
          value: "1",
        },
      ],
    },
    autoRenew: {
      type: "string",
      label: "Auto Renew",
      description: "Whether to automatically renew the domain.",
      optional: true,
      options: [
        {
          label: "Do not auto-renew",
          value: "0",
        },
        {
          label: "Auto-renew",
          value: "1",
        },
      ],
    },
    period: {
      type: "string",
      label: "Period",
      description: "The length of the registration period. Allowed values are `1-10`, depending on the TLD, that is, not all registries allow for a 1-year registration. The default is `2`, which is valid for all TLDs.",
      default: "2",
      options: [
        {
          label: "1 Year",
          value: "1",
        },
        {
          label: "2 Years",
          value: "2",
        },
        {
          label: "3 Years",
          value: "3",
        },
        {
          label: "4 Years",
          value: "4",
        },
        {
          label: "5 Years",
          value: "5",
        },
        {
          label: "6 Years",
          value: "6",
        },
        {
          label: "7 Years",
          value: "7",
        },
        {
          label: "8 Years",
          value: "8",
        },
        {
          label: "9 Years",
          value: "9",
        },
        {
          label: "10 Years",
          value: "10",
        },
      ],
    },
    customNameservers: {
      type: "string",
      label: "Custom Nameservers",
      description: "Custom nameservers for the domain.",
      reloadProps: true,
      options: [
        {
          label: "Use reseller's default nameservers",
          value: "0",
        },
        {
          label: "Use nameservers provided in request",
          value: "1",
        },
      ],
    },
    jsonOutput: {
      type: "boolean",
      label: "JSON Output",
      description: "Whether to output the response in JSON format.",
      optional: true,
      default: true,
    },
  },
  additionalProps() {
    const { customNameservers } = this;
    if (customNameservers === "1") {
      return {
        nameserverList: {
          type: "string[]",
          label: "Nameserver List",
          description: "List of nameservers for the domain. Eg. `ns1.opensrs.net`, `ns2.opensrs.net`.",
        },
      };
    }
    return {};
  },
  methods: {
    getJsonBody() {
      const {
        domain,
        regUsername,
        regPassword,
        ownerFirstName,
        ownerLastName,
        ownerEmail,
        ownerOrgName,
        ownerPhone,
        ownerAddress1,
        ownerCity,
        ownerCountry,
        ownerState,
        ownerPostalCode,
        adminFirstName,
        adminLastName,
        adminEmail,
        adminOrgName,
        adminPhone,
        adminAddress1,
        adminCity,
        adminCountry,
        adminState,
        adminPostalCode,
        billingFirstName,
        billingLastName,
        billingEmail,
        billingOrgName,
        billingPhone,
        billingAddress1,
        billingCity,
        billingCountry,
        billingState,
        billingPostalCode,
        techFirstName,
        techLastName,
        techEmail,
        techOrgName,
        techPhone,
        techAddress1,
        techCity,
        techCountry,
        techState,
        techPostalCode,
        customTechContact,
        autoRenew,
        customNameservers,
        nameserverList,
        period,
      } = this;
      return {
        data_block: {
          dt_assoc: {
            item: [
              ...utils.addItem("protocol", constants.PROTOCOL.XCP),
              ...utils.addItem("object", constants.OBJECT_TYPE.DOMAIN),
              ...utils.addItem("action", constants.ACTION_TYPE.SW_REGISTER),
              {
                "@_key": "attributes",
                "dt_assoc": {
                  item: [
                    ...utils.addItem("domain", domain),
                    ...utils.addItem("reg_username", regUsername),
                    ...utils.addItem("reg_password", regPassword),
                    ...utils.addItem("reg_type", constants.REGISTRY_TYPE.NEW),
                    ...utils.addItem("custom_nameservers", customNameservers),
                    ...utils.addItem("period", period),
                    ...utils.addItem("auto_renew", autoRenew),
                    ...utils.addItemList(
                      "nameserver_list",
                      customNameservers === "1"
                        ? nameserverList || []
                        : constants.DEFAULT_NAMESERVER_LIST,
                    ),
                    ...utils.addItem("custom_tech_contact", customTechContact),
                    {
                      "@_key": "contact_set",
                      "dt_assoc": {
                        item: [
                          {
                            "@_key": "owner",
                            "dt_assoc": {
                              item: [
                                ...utils.addItem("first_name", ownerFirstName),
                                ...utils.addItem("last_name", ownerLastName),
                                ...utils.addItem("phone", ownerPhone),
                                ...utils.addItem("email", ownerEmail),
                                ...utils.addItem("address1", ownerAddress1),
                                ...utils.addItem("city", ownerCity),
                                ...utils.addItem("state", ownerState),
                                ...utils.addItem("country", ownerCountry),
                                ...utils.addItem("postal_code", ownerPostalCode),
                                ...utils.addItem("org_name", ownerOrgName),
                              ],
                            },
                          },
                          {
                            "@_key": "admin",
                            "dt_assoc": {
                              item: [
                                ...utils.addItem("first_name", adminFirstName),
                                ...utils.addItem("last_name", adminLastName),
                                ...utils.addItem("phone", adminPhone),
                                ...utils.addItem("email", adminEmail),
                                ...utils.addItem("address1", adminAddress1),
                                ...utils.addItem("city", adminCity),
                                ...utils.addItem("state", adminState),
                                ...utils.addItem("country", adminCountry),
                                ...utils.addItem("postal_code", adminPostalCode),
                                ...utils.addItem("org_name", adminOrgName),
                              ],
                            },
                          },
                          {
                            "@_key": "billing",
                            "dt_assoc": {
                              item: [
                                ...utils.addItem("first_name", billingFirstName),
                                ...utils.addItem("last_name", billingLastName),
                                ...utils.addItem("phone", billingPhone),
                                ...utils.addItem("email", billingEmail),
                                ...utils.addItem("address1", billingAddress1),
                                ...utils.addItem("city", billingCity),
                                ...utils.addItem("state", billingState),
                                ...utils.addItem("country", billingCountry),
                                ...utils.addItem("postal_code", billingPostalCode),
                                ...utils.addItem("org_name", billingOrgName),
                              ],
                            },
                          },
                          {
                            "@_key": "tech",
                            "dt_assoc": {
                              item: [
                                ...utils.addItem("first_name", techFirstName),
                                ...utils.addItem("last_name", techLastName),
                                ...utils.addItem("phone", techPhone),
                                ...utils.addItem("email", techEmail),
                                ...utils.addItem("address1", techAddress1),
                                ...utils.addItem("city", techCity),
                                ...utils.addItem("state", techState),
                                ...utils.addItem("country", techCountry),
                                ...utils.addItem("postal_code", techPostalCode),
                                ...utils.addItem("org_name", techOrgName),
                              ],
                            },
                          },
                        ],
                      },
                    },
                  ],
                },
              },
            ],
          },
        },
      };
    },
    registerDomain(args = {}) {
      return this.app.post(args);
    },
  },
  async run({ $ }) {
    const {
      registerDomain,
      getJsonBody,
      jsonOutput,
    } = this;

    const response = await registerDomain({
      $,
      jsonBody: getJsonBody(),
      jsonOutput,
    });

    $.export("$summary", "Successfully registered domain.");
    return response;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
OpenSRS	`app`	`app`	This component uses the OpenSRS app.
Domain	`domain`	`string`	The domain name to register, update, or transfer.
Reseller Username	`regUsername`	`string`	Usernames must be 3-20 characters in length. You can use any of the following alphanumeric characters: `A-Z`, `a-z`, `0-9`.
Reseller Password	`regPassword`	`string`	Passwords must be 10-20 characters in length. You can use any of the following alphanumeric characters and symbols: `A-Z`, `a-z`, `0-9`, `! @$^,.~\|=-+_{}#`.
Owner First Name	`ownerFirstName`	`string`	The first name of the owner of the domain.
Owner Last Name	`ownerLastName`	`string`	The last name of the owner of the domain.
Owner Email	`ownerEmail`	`string`	The email of the owner of the domain.
Owner Organization Name	`ownerOrgName`	`string`	The organization name of the owner of the domain.
Owner Phone	`ownerPhone`	`string`	The phone number of the owner of the domain.
Owner Address 1	`ownerAddress1`	`string`	The first line of the address of the owner of the domain.
Owner City	`ownerCity`	`string`	The city of the owner of the domain.
Owner Country	`ownerCountry`	`string`	The country of the owner of the domain.
Owner State	`ownerState`	`string`	The state of the owner of the domain.
Owner Postal Code	`ownerPostalCode`	`string`	The postal code of the owner of the domain.
Admin First Name	`adminFirstName`	`string`	The first name of the admin of the domain.
Admin Last Name	`adminLastName`	`string`	The last name of the admin of the domain.
Admin Email	`adminEmail`	`string`	The email of the admin of the domain.
Admin Organization Name	`adminOrgName`	`string`	The organization name of the admin of the domain.
Admin Phone	`adminPhone`	`string`	The phone number of the admin of the domain.
Admin Address 1	`adminAddress1`	`string`	The first line of the address of the admin of the domain.
Admin City	`adminCity`	`string`	The city of the admin of the domain.
Admin Country	`adminCountry`	`string`	The country of the admin of the domain.
Admin State	`adminState`	`string`	The state of the admin of the domain.
Admin Postal Code	`adminPostalCode`	`string`	The postal code of the admin of the domain.
Billing First Name	`billingFirstName`	`string`	The first name of the billing contact of the domain.
Billing Last Name	`billingLastName`	`string`	The last name of the billing contact of the domain.
Billing Email	`billingEmail`	`string`	The email of the billing contact of the domain.
Billing Organization Name	`billingOrgName`	`string`	The organization name of the billing contact of the domain.
Billing Phone	`billingPhone`	`string`	The phone number of the billing contact of the domain.
Billing Address 1	`billingAddress1`	`string`	The first line of the address of the billing contact of the domain.
Billing City	`billingCity`	`string`	The city of the billing contact of the domain.
Billing Country	`billingCountry`	`string`	The country of the billing contact of the domain.
Billing State	`billingState`	`string`	The state of the billing contact of the domain.
Billing Postal Code	`billingPostalCode`	`string`	The postal code of the billing contact of the domain.
Tech First Name	`techFirstName`	`string`	The first name of the tech contact of the domain.
Tech Last Name	`techLastName`	`string`	The last name of the tech contact of the domain.
Tech Email	`techEmail`	`string`	The email of the tech contact of the domain.
Tech Organization Name	`techOrgName`	`string`	The organization name of the tech contact of the domain.
Tech Phone	`techPhone`	`string`	The phone number of the tech contact of the domain.
Tech Address 1	`techAddress1`	`string`	The first line of the address of the tech contact of the domain.
Tech City	`techCity`	`string`	The city of the tech contact of the domain.
Tech Country	`techCountry`	`string`	The country of the tech contact of the domain.
Tech State	`techState`	`string`	The state of the tech contact of the domain.
Tech Postal Code	`techPostalCode`	`string`	The postal code of the tech contact of the domain.
Custom Tech Contact	`customTechContact`	`string`	Select a value from the drop down menu:`{ "label": "Use reseller's tech contact info.", "value": "0" }{ "label": "Use tech contact info provided in request.", "value": "1" }`
Auto Renew	`autoRenew`	`string`	Select a value from the drop down menu:`{ "label": "Do not auto-renew", "value": "0" }{ "label": "Auto-renew", "value": "1" }`
Period	`period`	`string`	Select a value from the drop down menu:`{ "label": "1 Year", "value": "1" }{ "label": "2 Years", "value": "2" }{ "label": "3 Years", "value": "3" }{ "label": "4 Years", "value": "4" }{ "label": "5 Years", "value": "5" }{ "label": "6 Years", "value": "6" }{ "label": "7 Years", "value": "7" }{ "label": "8 Years", "value": "8" }{ "label": "9 Years", "value": "9" }{ "label": "10 Years", "value": "10" }`
Custom Nameservers	`customNameservers`	`string`	Select a value from the drop down menu:`{ "label": "Use reseller's default nameservers", "value": "0" }{ "label": "Use nameservers provided in request", "value": "1" }`
JSON Output	`jsonOutput`	`boolean`	Whether to output the response in JSON format.

Action Authentication#

OpenSRS uses API keys for authentication. When you connect your OpenSRS account, Pipedream securely stores the keys so you can easily authenticate to OpenSRS APIs in both code and no-code steps.

About OpenSRS#

Reseller Platform for Domains, Email, and SSL

More Ways to Connect OpenSRS + HTTP / Webhook#

Other Popular Integrations#

Initiate Domain Transfer with OpenSRS API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + OpenSRS