For backward compatibility, this endpoint is also aliased at https://app.okayhq.com/api/webhooks/events
Merge and Deploy events enable Okay to build Deploy Frequency and Lead Time metrics.
In addition to the following documentation, we provide an open-source repository of Github Actions with default implementations of these API calls for a typical Github workflow.
Merge Event
Since Okay does not have access to source code, there is no way for it to know commit hashes once pull requests get merged to the main branch. Okay only knows commit hashes in the context of an open pull request, and these hashes are different from the ones on the main branch.
The merge event enables you to link these 2 distinct commit hashes, in order for Okay to understand the history of a pull request from open to merge to deploy.
Deploy Event
The deploy event signals to Okay that a commit has been deployed.
Note that, for lead time calculations, the latest deploy will be used.