​
Redmine Provider

RedmineProvider is a class that integrates with Redmine to manage issue tracking through Keep.

​
Authentication

This provider requires authentication.

  • host: Redmine Host (required: True, sensitive: False)
  • api_access_key: Redmine API Access key (required: True, sensitive: True)

Certain scopes may be required to perform specific actions or queries via the provider. Below is a summary of relevant scopes and their use cases:

  • authenticated: Authenticated with Redmine API (mandatory)

​
In workflows

This provider can be used in workflows.

As “action” to make changes or update data, example:

actions:
    - name: Query redmine
      provider: redmine
      config: "{{ provider.my_provider_name }}"
      with:
        project_id: {value}  
        subject: {value}  
        priority_id: {value}  
        description: {value}

If you need workflow examples with this provider, please raise a GitHub issue.

​
Connecting with the Provider

To connect with the Redmine provider and manage issues through Keep, follow these steps:

  1. Obtain a Redmine Personal Access Token: Visit the Redmine API documentation to see the steps to get an API key.
  2. Use the following YAML example to create an issue using the Redmine provider, all these are valid arguments:
examples/issue_creation_example.yml
# Create an issue using the Redmine provider.
task:
  id: create-redmine-issue
  description: Create an issue in Redmine
  actions:
    - name: create-issue
      provider:
        type: redmine
        config: "{{ providers.redmine-provider }}"
        with:
          project_id: "example_project"
          subject: "Issue Subject"
          priority_id: "2"
          description: "This is the issue description."