API-Advanced Custom Development

The Breeze API (application programming interface) allows churches to build custom functionality integrated with Breeze. To locate the API in your Breeze account simply navigate to

1. More

2. Extensions

3. Breeze API

If you have someone with programming talent in your community, that person can use the Breeze API to build your own custom applications on top of Breeze. Want the check in functions to operate differently? Want to pull people's data into a separate system? Integrate away!

 

View Full API Documentation

Delays in syncing are expected as ping backs don’t happen immediately on either side of the integration. To limit traffic there’s a delay between how often an app or website can communicate and request information from Breeze.
As of Feb 1, 2020, we will no longer be able to provide support for our current API.
Was this article helpful?
7 out of 16 found this helpful

Comments

15 comments
  • I was referred to this thread, but I had a specific question. If someone from my church has API knowledge, would they be able to adjust how the name tags are printed? The categories in the reference guide does not indicate anything about possibly changing the print options for the name tags or even changing the way the name tags look?

    0
  • Hi @j6shin!

    Thanks for reaching out. Great question in what you're trying to accomplish in Breeze. However, this would be bumping in to some of our limitations and would not be possible to do at this time. 

    While this may not be the ideal answer you were hoping for, I do hope the information is helpful.

    Happy Breezing! 

     

     

    0
  • it was my understanding that as Breeze was being rewritten that access to new APIs would eventually be available. Is there a time frame on when those APIs will be available?

    1
  • @samstack

    Great question! There is currently no timeline for when the new API will be released. However, we will be releasing that information as the time grows closer. Thank you for your patience with us as we continue to develop Breeze to your needs. 

    0
  • Stephen Ivey, it's been a month since you responded to the question above about the release of the new API. Is there a link you could send me where the developers are posting updates for this, or do you have any updates to provide?

    3
  • I would also be interested in info about the new API. We are currently using a demo and a good, solid API would be a key factor in determining this as an option for our organization. Thanks!

    0
  • I agree with ron and stephenwallace. You are no longer supporting the current API, but you're not telling customers and prospective customers when the new API is expected to be online? That is not the kind of service we expected from Breeze. Please give us some info on this transition.

    0
  • @Stephen Ivey Any chance you or @Emily W could look into this API question and let us know?

    0
  • Hello friends! 

    Kris here with Breeze Support. I get to lead the Technical Specialist Team and we are regularly having conversations with our Product and Development Team regarding the current API, as well as APIv2 so I wanted to take the time to respond to your questions and concerns here. 

    It was following much conversation that the decision was made to stop supporting questions related to the usage of the current API by our team. I'm happy to allow you guys a peak into that rationale. 

    In the spirit of honesty, if one of you guys who are used to working with API needs assistance with said API, it means that one of our Advisors of Specialists will not be suited to support you. That means it will take a Developer to assist. This means that your questions would be routed through our processes where it would wait to be assigned to an available Developer who would then pass along the answer to our team back to you guys. 

    This process, while not ideal, served us well for several years. However we recognized that it's not serving anyone (including you guys as end users) well. It adds a significant time barrier to your work for your local church when you have to wait for a response from us regarding your API needs. Thus, it's simply not practical to continue this level of support for the API. 

    Additionally, this is not an efficient or effective way to utilize our Development resources. Our teams were fielding 6-8 requests a week regarding the API and it was placing a large burden on our Developers to support question from fellow Developers, versus writing code. I recognize that this places more of a burden on each of you, however this is the best path forward as we strive to leverage our Developers in the best way possible - and that is writing code versus supporting end users. 

    In terms of timing for the release of APIv2: I'd love to give you an exact timeline (that is within the next 7 days even). However, for anyone accustomed to coding we recognize that these processes take time. We're working on an extremely ambitious project to re-write the underpinnings of Breeze and add in ways that you guys as end users can leverage Breeze in some really cool ways to benefit your church. We're also doing it as quickly as possible. With that being said, I just can't provide a firm timeline. Our goal is before the end of the year (ideally well before that mark), but it's going to take a lot of work to get there. 

    What do you do for now?

    While we won't be supporting your API questions via our Support Team, we did want to be sure you had options available for peer support with other end users. You can visit our Githhub Issues page, or the Facebook Users Group and interact with others who are leveraging Breeze in their local contexts.

    Thanks for your comments and feel free to reach out if you need any further clarification!

    Cheers!

    0
  • Yet another question about the timeframe for the new API. Any update?

    0
  • Good Morning!


    Since my last update, there aren't too many updates that would be beneficial to share here. While I could tell you which Software Engineer is engaged in writing which section of Breeze, and their progress - it wouldn't actually be helpful for you guys. 

    What I can do is tell you that our team is working as diligently as possible to have the Breeze API v2 out in the wild as quickly as possible. There are scores of other improvements and projects we would love to do, and it relies on the upgraded API. Trust me when I tell you we want this finished as badly as you guys do. 

    As we get to the point of releasing the new API, know that we'll be sharing updates via our update emails as well as via social media so be sure to keep a lookout there!

     

    0
  • Do you guys have like a Javascript API that we can use?

     

    0
  • Hi @paolo,

    Great question. Unfortunately, we do not have an API for JavaScript. I apologize if that creates any inconveniences for you and your church! 

    0
  • I'm developing a mobile app for our church and we're going to have the directory natively on there using the API. But I don't want the whole world to access people's private information so a login gate is required. Is there a way, using the Breeze API, to use the users Breeze login? My other option is to create a login separate for the app, but that isn't ideal.

    0
  • @uncommonjoe

     

    Great question! Currently there is not the option to use their Breeze login outside of Breeze itself. What if you guys linked directly to the Breeze people page versus trying to have a native directory present?

    0