Skip to content

Splitting webhook integration content over separate pages #9379

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
May 22, 2025

Conversation

yaningo
Copy link
Contributor

@yaningo yaningo commented May 9, 2025

Description

Splitting webhook integration content over two separate pages:

  • Custom webhooks (under "Orchestrate and trigger > Trigger")
  • Outbound webhooks (under "Integration > Integration features")

Reasons

Having both types of webhooks on the same page was confusing.

Content Checklist

Please follow our style when contributing to CircleCI docs. Our style guide is here: https://circleci.com/docs/style/style-guide-overview.

Please take a moment to check through the following items when submitting your PR (this is just a guide so will not be relevant for all PRs) 😸:

  • Break up walls of text by adding paragraph breaks.
  • Consider if the content could benefit from more structure, such as lists or tables, to make it easier to consume.
  • Keep the title between 20 and 70 characters.
  • Consider whether the content would benefit from more subsections (h2-h6 headings) to make it easier to consume.
  • Check all headings h1-h6 are in sentence case (only first letter is capitalized).
  • Is there a "Next steps" section at the end of the page giving the reader a clear path to what to read next?
  • Include relevant backlinks to other CircleCI docs/pages.

@yaningo yaningo marked this pull request as ready for review May 14, 2025 13:03
@yaningo yaningo requested review from a team as code owners May 14, 2025 13:03
Copy link
Contributor

@rosieyohannan rosieyohannan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Big improvement, thank you!


TIP: Custom webhooks are inbound to CircleCI and are used to trigger pipelines from other services. If you are looking for a way to have a CircleCI pipeline trigger a service, use an xref:outbound-webhooks#[outbound webhook].

This section presents some use cases for CircleCI custom webhooks.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this line needs to be in the section for examples below the quickstart?

@yaningo yaningo requested a review from rosieyohannan May 20, 2025 14:22
@yaningo yaningo merged commit 7609f5d into master May 22, 2025
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants