orbit.json•15.6 kB
{
"nodeType": "n8n-nodes-base.orbit",
"displayName": "Orbit",
"description": "Consume Orbit API",
"version": 1,
"properties": [
{
"name": "workspaceId",
"displayName": "Workspace Name or ID",
"type": "options",
"default": "Deprecated",
"description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
"required": true,
"displayOptions": {
"show": {
"resource": [
"activity"
],
"operation": [
"create"
]
}
}
},
{
"name": "memberId",
"displayName": "Member ID",
"type": "string",
"default": "",
"required": true,
"displayOptions": {
"show": {
"resource": [
"activity"
],
"operation": [
"create"
]
}
}
},
{
"name": "title",
"displayName": "Title",
"type": "string",
"default": "",
"required": true,
"displayOptions": {
"show": {
"resource": [
"activity"
],
"operation": [
"create"
]
}
}
},
{
"name": "additionalFields",
"displayName": "Additional Fields",
"type": "collection",
"default": {},
"description": "A user-defined way to group activities of the same nature. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
"placeholder": "Add Field",
"options": [
{
"name": "activityType",
"displayName": "Activity Type Name or ID",
"type": "options",
"default": "Deprecated",
"description": "A user-defined way to group activities of the same nature. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
},
{
"name": "description",
"displayName": "Description",
"type": "string",
"default": "",
"description": "A description of the activity; displayed in the timeline"
},
{
"name": "key",
"displayName": "Key",
"type": "string",
"default": "",
"description": "Supply a key that must be unique or leave blank to have one generated"
},
{
"name": "link",
"displayName": "Link",
"type": "string",
"default": "",
"description": "A URL for the activity; displayed in the timeline"
},
{
"name": "linkText",
"displayName": "Link Text",
"type": "string",
"default": "",
"description": "The text for the timeline link"
},
{
"name": "occurredAt",
"displayName": "Occurred At",
"type": "dateTime",
"default": "",
"description": "The date and time the activity occurred; defaults to now"
}
],
"displayOptions": {
"show": {
"resource": [
"activity"
],
"operation": [
"create"
]
}
}
},
{
"name": "returnAll",
"displayName": "Return All",
"type": "boolean",
"default": false,
"description": "Whether to return all results or only up to a given limit",
"displayOptions": {
"show": {
"operation": [
"getAll"
],
"resource": [
"activity"
]
}
}
},
{
"name": "limit",
"displayName": "Limit",
"type": "number",
"default": 100,
"description": "Max number of results to return",
"typeOptions": {
"minValue": 1,
"maxValue": 500
},
"displayOptions": {
"show": {
"operation": [
"getAll"
],
"resource": [
"activity"
],
"returnAll": [
false
]
}
}
},
{
"name": "filters",
"displayName": "Filters",
"type": "collection",
"default": {},
"description": "When set the post will be filtered by the member ID",
"placeholder": "Add Filter",
"options": [
{
"name": "memberId",
"displayName": "Member ID",
"type": "string",
"default": "",
"description": "When set the post will be filtered by the member ID"
}
],
"displayOptions": {
"show": {
"resource": [
"activity"
],
"operation": [
"getAll"
]
}
}
},
{
"name": "operation",
"displayName": "Operation",
"type": "options",
"default": "create",
"description": "Create an activity for a member",
"options": [
{
"name": "Create",
"value": "create",
"description": "Create an activity for a member"
},
{
"name": "Get Many",
"value": "getAll",
"description": "Get many activities"
}
],
"displayOptions": {
"show": {
"resource": [
"activity"
]
}
}
},
{
"name": "resolveIdentities",
"displayName": "Resolve Identities",
"type": "boolean",
"default": false,
"description": "By default, the response just includes the reference of the identity. When set to true the identities will be resolved automatically.",
"displayOptions": {
"show": {
"operation": [
"get"
],
"resource": [
"member"
]
}
}
},
{
"name": "options",
"displayName": "Options",
"type": "collection",
"default": {},
"description": "Name of the field the response will be sorted by",
"placeholder": "Add option",
"options": [
{
"name": "sort",
"displayName": "Sort By",
"type": "string",
"default": "",
"description": "Name of the field the response will be sorted by"
}
],
"displayOptions": {
"show": {
"resource": [
"member"
],
"operation": [
"getAll"
]
}
}
},
{
"name": "source",
"displayName": "Source",
"type": "options",
"default": "",
"description": "Set to github, twitter, email, discourse or the source of any identities you've manually created",
"required": true,
"options": [
{
"name": "Discourse",
"value": "discourse"
},
{
"name": "Email",
"value": "email"
},
{
"name": "GitHub",
"value": "github"
},
{
"name": "Twitter",
"value": "twitter"
}
],
"displayOptions": {
"show": {
"resource": [
"member"
],
"operation": [
"lookup"
]
}
}
},
{
"name": "searchBy",
"displayName": "Search By",
"type": "options",
"default": "",
"required": true,
"options": [
{
"name": "Username",
"value": "username"
},
{
"name": "ID",
"value": "id"
}
],
"displayOptions": {
"show": {
"resource": [
"member"
],
"operation": [
"lookup"
],
"source": [
"discourse",
"github",
"twitter"
]
}
}
},
{
"name": "id",
"displayName": "ID",
"type": "string",
"default": "",
"description": "The username at the source",
"required": true,
"displayOptions": {
"show": {
"resource": [
"member"
],
"operation": [
"lookup"
],
"searchBy": [
"id"
],
"source": [
"discourse",
"github",
"twitter"
]
}
}
},
{
"name": "username",
"displayName": "Username",
"type": "string",
"default": "",
"description": "The username at the source",
"required": true,
"displayOptions": {
"show": {
"resource": [
"member"
],
"operation": [
"lookup"
],
"searchBy": [
"username"
],
"source": [
"discourse",
"github",
"twitter"
]
}
}
},
{
"name": "email",
"displayName": "Email",
"type": "string",
"default": "",
"description": "The email address",
"placeholder": "name@email.com",
"required": true,
"displayOptions": {
"show": {
"resource": [
"member"
],
"operation": [
"lookup"
],
"source": [
"email"
]
}
}
},
{
"name": "host",
"displayName": "Host",
"type": "string",
"default": "",
"required": true,
"displayOptions": {
"show": {
"resource": [
"member"
],
"operation": [
"lookup"
],
"source": [
"discourse"
]
}
}
},
{
"name": "updateFields",
"displayName": "Update Fields",
"type": "collection",
"default": {},
"description": "Adds tags to member; comma-separated string or array",
"placeholder": "Add Field",
"options": [
{
"name": "bio",
"displayName": "Bio",
"type": "string",
"default": ""
},
{
"name": "birthday",
"displayName": "Birthday",
"type": "dateTime",
"default": ""
},
{
"name": "company",
"displayName": "Company",
"type": "string",
"default": ""
},
{
"name": "location",
"displayName": "Location",
"type": "string",
"default": ""
},
{
"name": "name",
"displayName": "Name",
"type": "string",
"default": ""
},
{
"name": "pronouns",
"displayName": "Pronouns",
"type": "string",
"default": ""
},
{
"name": "shippingAddress",
"displayName": "Shipping Address",
"type": "string",
"default": ""
},
{
"name": "slug",
"displayName": "Slug",
"type": "string",
"default": ""
},
{
"name": "tagsToAdd",
"displayName": "Tags to Add",
"type": "string",
"default": "",
"description": "Adds tags to member; comma-separated string or array"
},
{
"name": "tagList",
"displayName": "Tag List",
"type": "string",
"default": "",
"description": "Replaces all tags for the member; comma-separated string or array"
},
{
"name": "tShirt",
"displayName": "T-Shirt",
"type": "string",
"default": ""
},
{
"name": "teammate",
"displayName": "Teammate",
"type": "boolean",
"default": false
},
{
"name": "url",
"displayName": "URL",
"type": "string",
"default": ""
}
],
"displayOptions": {
"show": {
"resource": [
"member"
],
"operation": [
"update"
]
}
}
},
{
"name": "identityUi",
"displayName": "Identity",
"type": "fixedCollection",
"default": {},
"description": "The identity is used to find the member. If no member exists, a new member will be created and linked to the provided identity.",
"placeholder": "Add Identity",
"required": true,
"displayOptions": {
"show": {
"resource": [
"member"
],
"operation": [
"upsert"
]
}
}
},
{
"name": "note",
"displayName": "Note",
"type": "string",
"default": "",
"required": true,
"displayOptions": {
"show": {
"resource": [
"note"
],
"operation": [
"create"
]
}
}
},
{
"name": "resolveMember",
"displayName": "Resolve Member",
"type": "boolean",
"default": false,
"displayOptions": {
"show": {
"operation": [
"getAll"
],
"resource": [
"note"
]
}
}
},
{
"name": "noteId",
"displayName": "Note ID",
"type": "string",
"default": "",
"required": true,
"displayOptions": {
"show": {
"resource": [
"note"
],
"operation": [
"update"
]
}
}
},
{
"name": "url",
"displayName": "URL",
"type": "string",
"default": "",
"description": "Supply any URL and Orbit will do its best job to parse out a title, description, and image",
"required": true,
"displayOptions": {
"show": {
"resource": [
"post"
],
"operation": [
"create"
]
}
}
},
{
"name": "postId",
"displayName": "Post ID",
"type": "string",
"default": "",
"required": true,
"displayOptions": {
"show": {
"operation": [
"delete"
],
"resource": [
"post"
]
}
}
},
{
"name": "deprecated",
"displayName": "Orbit has been shutdown and will no longer function from July 11th, You can read more <a target=\"_blank\" href=\"https://orbit.love/blog/orbit-is-joining-postman\">here</a>.",
"type": "notice",
"default": ""
},
{
"name": "resource",
"displayName": "Resource",
"type": "options",
"default": "member",
"options": [
{
"name": "Activity",
"value": "activity"
},
{
"name": "Member",
"value": "member"
},
{
"name": "Note",
"value": "note"
},
{
"name": "Post",
"value": "post"
}
]
}
],
"credentialsConfig": [
{
"name": "orbitApi",
"required": true
},
{
"name": "deprecated",
"required": false
},
{
"name": "Deprecated",
"required": false
}
],
"io": {
"inputs": [],
"outputs": [],
"outputNames": [],
"hints": {}
},
"wiring": {
"role": "generic",
"requires": [],
"optional": [],
"consumedBy": [],
"consumes": [],
"produces": []
}
}