[GH-ISSUE #1127] Create an itegration using the API #781

Closed
opened 2026-02-25 23:43:34 +03:00 by kerem · 7 comments
Owner

Originally created by @youpie on GitHub (Feb 19, 2025).
Original GitHub issue: https://github.com/healthchecks/healthchecks/issues/1127

Hello,

I am writing an application and want to be able to inform the user if their specific instance is down. For this I assume I need to create an integration for every check. But I don't see a possibility to create an integration using the API. Is there a way to achieve it, or do I need to create a new integration in the UI every time? (I just need an email integration)

Originally created by @youpie on GitHub (Feb 19, 2025). Original GitHub issue: https://github.com/healthchecks/healthchecks/issues/1127 Hello, I am writing an application and want to be able to inform the user if their specific instance is down. For this I assume I need to create an integration for every check. But I don't see a possibility to create an integration using the API. Is there a way to achieve it, or do I need to create a new integration in the UI every time? (I just need an email integration)
kerem closed this issue 2026-02-25 23:43:34 +03:00
Author
Owner

@cuu508 commented on GitHub (Feb 19, 2025):

You don't need a separate integration for every check. You can have a single email integration, and associate it with every check.

In the Create a Check API call, if you pass in a field "channels": "*", Healthchecks will automatically assign all existing integrations to it.

<!-- gh-comment-id:2668566511 --> @cuu508 commented on GitHub (Feb 19, 2025): You don't need a separate integration for every check. You can have a single email integration, and associate it with every check. In the [Create a Check](https://healthchecks.io/docs/api/#create-check) API call, if you pass in a field `"channels": "*"`, Healthchecks will automatically assign all existing integrations to it.
Author
Owner

@youpie commented on GitHub (Feb 19, 2025):

You can have a single email integration, and associate it with every check.

I need every check to go to a different email adres, the one of the user associated with that check

<!-- gh-comment-id:2668570289 --> @youpie commented on GitHub (Feb 19, 2025): > You can have a single email integration, and associate it with every check. I need every check to go to a different email adres, the one of the user associated with that check
Author
Owner

@cuu508 commented on GitHub (Feb 26, 2025):

Ah I see. Can you describe your use case a little more? How many users are you working with?

In general though, I'm currently not planning to add API support for creating integrations:

  • for typical use cases you should only need a few integrations per project, and can create them by hand. Healthchecks is not designed for tens or hundreds of integrations per project.
  • many integration types, including email, require interactive actions during setup (clicking a confirmation link, clicking through OAuth flow). Adding API support for the specific setup steps of each integration would be a lot of work, with unclear benefit.
<!-- gh-comment-id:2684489133 --> @cuu508 commented on GitHub (Feb 26, 2025): Ah I see. Can you describe your use case a little more? How many users are you working with? In general though, I'm currently not planning to add API support for creating integrations: * for typical use cases you should only need a few integrations per project, and can create them by hand. Healthchecks is not designed for tens or hundreds of integrations per project. * many integration types, including email, require interactive actions during setup (clicking a confirmation link, clicking through OAuth flow). Adding API support for the specific setup steps of each integration would be a lot of work, with unclear benefit.
Author
Owner

@youpie commented on GitHub (Feb 27, 2025):

@cuu508 I have an application. That periodically logs into a website and gets some data for it. Every user is its own application instance which is periodically ran through a cronjob. I have multiple users, and i want every user to be informed when their instance is down. So I need a way to create a check for every user, and an email integration for every check with a unique Email address.
I understand the difficulties of using an API for this purpose. Maybe a limited implementation of applications which do not need any sort of interactive elements could work?

<!-- gh-comment-id:2687290812 --> @youpie commented on GitHub (Feb 27, 2025): @cuu508 I have an application. That periodically logs into a website and gets some data for it. Every user is its own application instance which is periodically ran through a cronjob. I have multiple users, and i want every user to be informed when their instance is down. So I need a way to create a check for every user, and an email integration for every check with a unique Email address. I understand the difficulties of using an API for this purpose. Maybe a limited implementation of applications which do not need any sort of interactive elements could work?
Author
Owner

@cuu508 commented on GitHub (Feb 27, 2025):

How many users are you working with?

<!-- gh-comment-id:2687298652 --> @cuu508 commented on GitHub (Feb 27, 2025): How many users are you working with?
Author
Owner

@youpie commented on GitHub (Feb 27, 2025):

Not a lot, slowly increasing but it's incredibly niche. currently about 10 people, but i expect that to increase

<!-- gh-comment-id:2688351718 --> @youpie commented on GitHub (Feb 27, 2025): Not a lot, slowly increasing but it's incredibly niche. currently about 10 people, but i expect that to increase
Author
Owner

@cuu508 commented on GitHub (Mar 21, 2025):

For 10-30 users I would create the integrations by hand.

The easiest way to automate this would be to write a management command which takes a project id and an email address and creates an integration. Adding a new API endpoint would take a little bit more work but is also doable.

I'm not planning to implement this, but it could certainly be done in a fork.

<!-- gh-comment-id:2742580628 --> @cuu508 commented on GitHub (Mar 21, 2025): For 10-30 users I would create the integrations by hand. The easiest way to automate this would be to write a management command which takes a project id and an email address and creates an integration. Adding a new API endpoint would take a little bit more work but is also doable. I'm not planning to implement this, but it could certainly be done in a fork.
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/healthchecks#781
No description provided.