Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Following are some of the best practices you can adhere to when implementing connectors:

  • Always use lowercase lower case letters to name a connector. For example, activecampaign.

  • Make sure that the parameter values are atomic to the calling api. For example, if the api expects the following request to insert the firstname and lastname for a user, you need to provide the firstname and lastname as separate parameters when implementing the connector.

    Code Block
    titleRequest
    "user": {
           "firstname" : "someuser",
           "lastname" : "someuser",
           "groups" : [ "jira-users", "my-custom-group" ],
           "active" : true,
           "email" : "user1@example.com",
           "fullname" : "User 1"}

...

For answers to some of the common questions regarding implementing a connector, see the FAQ FAQs section.