{"id":19806011,"url":"https://github.com/cycloidio/cycloid-events-resource","last_synced_at":"2026-06-05T21:31:20.412Z","repository":{"id":52673875,"uuid":"149408415","full_name":"cycloidio/cycloid-events-resource","owner":"cycloidio","description":"Concourse resource to send events to Cycloid events engine","archived":false,"fork":false,"pushed_at":"2023-02-24T12:53:21.000Z","size":34,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-02-28T17:54:38.094Z","etag":null,"topics":["concourse","concourse-resource","events","python3"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cycloidio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2018-09-19T07:15:31.000Z","updated_at":"2022-03-04T17:13:26.000Z","dependencies_parsed_at":"2025-01-11T06:13:11.498Z","dependency_job_id":"36d74a82-ded2-48bc-85c2-ea38700a4347","html_url":"https://github.com/cycloidio/cycloid-events-resource","commit_stats":{"total_commits":24,"total_committers":3,"mean_commits":8.0,"dds":0.08333333333333337,"last_synced_commit":"ca00680d323916a2a00ecd634df74322664093cd"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/cycloidio/cycloid-events-resource","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cycloidio%2Fcycloid-events-resource","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cycloidio%2Fcycloid-events-resource/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cycloidio%2Fcycloid-events-resource/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cycloidio%2Fcycloid-events-resource/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cycloidio","download_url":"https://codeload.github.com/cycloidio/cycloid-events-resource/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cycloidio%2Fcycloid-events-resource/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33961252,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-05T02:00:06.157Z","response_time":120,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["concourse","concourse-resource","events","python3"],"created_at":"2024-11-12T09:06:09.719Z","updated_at":"2026-06-05T21:31:20.388Z","avatar_url":"https://github.com/cycloidio.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Cycloid Events Resource\n\nSend and receive events to/from [Cycloid DevOps framework](https://www.cycloid.io/devops-framework)\nOur framework has an Event endpoint in order to have a unique entrypoint to store and retrieve events in a centralized way.\nBy storing some events directly from the pipeline, you are able to give some visibility to important steps, but also store indefinitely an event like a production deployment.\n\n## Deploying to Concourse\n\nYou can use the docker image by defining the [resource type](https://concourse-ci.org/resource-types.html) in your pipeline YAML.\n\nFor example:\n\n```yaml\n\nresource_types:\n- name: cycloid-events\n  type: docker-image\n  source:\n    repository: cycloid/cycloid-events-resource\n    tag: latest\n\nresources:\n- name: cycloid-events\n  type: cycloid-events\n  source:\n    api_key: ((custom_api-key-admin.key))\n    api_url: 'https://http-api.cycloid.io'\n    icon: fa-code-branch\n    organization: cycloid-sandbox\n    type: Custom\n\njobs:\n  - name: test\n    plan:\n        ...\n        on_success:\n          do:\n            - params:\n                message: |\n                  Unit test success in $BUILD_PIPELINE_NAME for $BUILD_NAME\n                severity: info\n                title: $BUILD_PIPELINE_NAME - Unit test success\n              put: cycloid-events\n```\n\n## Source Configuration\n\nAll optional values below, if specified in the source, will act as a default value until it's overrided by the params configuration.\n\n* `api_url`: *Required.* The url of the Cycloid DevOps Platform API.\n    Example: `https://http-api.cycloid.io`\n\n* `api_key`: *Required*. The Cycloid API key you will use to send those events.\n\n* `organization`: *Required*. The organization where you will store the events.\n\n* `type`: *Optional*. The type of the event. Currently, only `Cycloid`, `Custom`, `AWS` or `Monitoring` are allowed.\n\n* `severity`: *Optional*. The severity of the event. Currently, only `info`, `warn`, `err` or `crit` are allowed.\n\n* `icon`: *Optional*. Icon to display. The icons are the ones from Font Awesome.\n    Example: `fa-cubes`\n\n* `title`: *Optional*. The title of the event.\n\n* `message`: *Optional*. The message in the event body.\n\n* `message_file`: *Optional*. File path which contain the message for event body.\n\n* `fail_on_error`: *Optional*. If true, the resource will fail if the Cycloid event API return an error. Default false (True values are y, yes, t, true, on and 1; false values are n, no, f, false, off and 0).\n\n* `vars_file`: *Optional*. Load vars from a file that you can use in event message or title. format `MYKEY: value` usage `my title containing vars $MYKEY`.\n\n* `tags`: *Optional*. The tags allow filtering.\n    Example:\n    ```\n    tags:\n      - key: project\n        value: myproject\n      - key: env\n        value: prod\n    ```\n\n## Behavior\n\n### `check`: Check for new events\n\nThe check is currently not implemented but it will allow to trigger a job when new events are populated.\n\n### `in`: Retrieve an event\n\nCurrently not implemented\n\n### `out`: Send an event to Cycloid\n\nSend the event to Cycloid API with the desired parameters.\n\n#### Parameters\n\n ```\n /!\\ *Required* parameters can be defined here or in the Source configuration /!\\\n ```\n\n* `type`: *Required*. The type of the event. Currently, only `Cycloid`, `Custom`, `AWS` or `Monitoring` are allowed.\n\n* `severity`: *Required*. The severity of the event. Currently, only `info`, `warn`, `err` or `crit` are allowed.\n\n* `icon`: *Required*. Icon to display. The icons are the ones from Font Awesome.\n    Example: `fa-cubes`\n\n* `title`: *Required*. The title of the event.\n\n* `message`: *Optional*. The message in the event body. (required `message` or `message_file` to be defined).\n\n* `message_file`: *Optional*. File path which contain the message for event body.\n\n* `fail_on_error`: *Optional*. If true, the resource will fail if the Cycloid event API return an error. Default false (True values are y, yes, t, true, on and 1; false values are n, no, f, false, off and 0).\n\n* `vars_file`: *Optional*. Load vars from a file that you can use in event message or title. format `MYKEY: value` usage `my title containing vars $MYKEY`.\n\n* `tags`: *Required*. The tags allow filtering.\n    Example:\n    ```\n    tags:\n      - key: project\n        value: myproject\n      - key: env\n        value: prod\n    ```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcycloidio%2Fcycloid-events-resource","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcycloidio%2Fcycloid-events-resource","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcycloidio%2Fcycloid-events-resource/lists"}