{"id":21502330,"url":"https://github.com/mrtcode/arkivo-slack","last_synced_at":"2026-05-03T09:35:10.491Z","repository":{"id":76796082,"uuid":"95188495","full_name":"mrtcode/arkivo-slack","owner":"mrtcode","description":"Get notifications to your Slack about newly added items in Zotero libraries","archived":false,"fork":false,"pushed_at":"2017-06-28T15:00:40.000Z","size":41,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-23T23:32:18.797Z","etag":null,"topics":["arkivo","plugin","slack","zotero"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mrtcode.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-06-23T06:06:23.000Z","updated_at":"2020-11-26T07:16:23.000Z","dependencies_parsed_at":null,"dependency_job_id":"57c40966-b4b0-46ec-9897-a5b50d40653a","html_url":"https://github.com/mrtcode/arkivo-slack","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrtcode%2Farkivo-slack","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrtcode%2Farkivo-slack/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrtcode%2Farkivo-slack/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrtcode%2Farkivo-slack/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mrtcode","download_url":"https://codeload.github.com/mrtcode/arkivo-slack/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244043480,"owners_count":20388589,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["arkivo","plugin","slack","zotero"],"created_at":"2024-11-23T18:14:33.825Z","updated_at":"2026-05-03T09:35:10.448Z","avatar_url":"https://github.com/mrtcode.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Arkivo Slack plugin example\nGet notifications to your Slack about newly added items in Zotero libraries.\n\n![Slack Screenshot](https://mrtcode.github.io/arkivo-slack/slack.png)\n\nThis is a plugin for Arkivo.\n[Arkivo](https://github.com/zotero/arkivo) is a plugin platform for processing created/updated/deleted\nitems from specified Zotero libraries.\n\n## Requirements\n* Node.js 7.6 or higher (needs await/async support)\n* Redis running on localhost:6379\n\n## Setup instructions\n\n### Download this plugin and install Node.js modules\n```\ngit clone https://github.com/mrtcode/arkivo-slack\ncd arkivo-slack\nnpm install\n```\n\n### Start Arkivo\nStart Arkivo with enabled debug output.\n```\nDEBUG=arkivo:* $(npm bin)/arkivo up\n```\n\n### Create a Slack Incoming WebHook URL for a specific channel.\n1. Go to https://my.slack.com/services/new/incoming-webhook/\n2. Choose a channel where you want this plugin to post messages.\n3. Click \"Add Incoming WebHook integration\".\n4. Copy the link from \"WebHook URL\" section.\n\n### Add an Arkivo subscription\nEach subscription can have multiple plugins and each plugin can have a different configuration that is valid only for the specific subscription.\n\nArkivo has an integrated HTTP API which can be used to create, list or delete subscriptions.\n\nHere is a request example to create a subscription with an activated and configured Arkivo Slack plugin:\n\n```\ncurl -X POST http://localhost:8888/api/subscription \\\n-H 'Content-Type: application/json' \\\n-d @- \u003c\u003c EOF\n{\n  \"url\": \"/users/123456/items/top\",\n  \"key\": \"vdZB5zVvYbai7ETJlln5vRyi\",\n  \"skip\": true,\n  \"plugins\": [\n    {\n      \"name\": \"slack\",\n      \"options\": {\n        \"webhookUrl\": \"https://hooks.slack.com/services/V9XBFPRFA/Y7XCFK4WG/ejO6LLyVlRKNqRpi1p4V2Mga\"\n      }\n    }\n  ]\n}\nEOF\n```\n\nExplanation of JSON parameters in the request:\n\n* `url` - A path part of Zotero API endpoint URL that returns item array. For example:\n\t* `/users/123456/items` - fetch all updated items.\n\t* `/groups/123456/items?tag=tag1` - fetch items with a matching tag.\n\t* `/users/123456/items?q=title` - fetch items with a matching title.\n\t* `/groups/123456/items?itemType=book` - fetch items with a matching item type.\n\t* `/users/123456/collections/HNR32E9N/items` - fetch items from a specified collection.\n* `key` - A Zotero access key to the library we are subscribing. For public libraries key isn't necessary.\n* `skip` - Skip processing already existing items.\n* `plugins[].name` - Activates the plugin for the current subscription.\n* `plugins[].options` - Plugin options for the current subscription. Only `webhookUrl` is necessary for this plugin.\n\n### List all Arkivo subscriptions\n```\ncurl http://localhost:8888/api/subscription\n```\n\n### Delete a subscription\n```\ncurl -X \"DELETE\" http://localhost:8888/api/subscription/SUBSCRIPTION_ID\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmrtcode%2Farkivo-slack","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmrtcode%2Farkivo-slack","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmrtcode%2Farkivo-slack/lists"}