From 4beebb5c84c014746a4d1d272a66ef68a6427095 Mon Sep 17 00:00:00 2001 From: David Coplowe Date: Thu, 7 Mar 2024 10:21:34 +0000 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Polina <112084241+pzaichkina@users.noreply.github.com> Co-authored-by: Max Clayton Clowes --- docs/using-the-api/webhooks/create-consumer.md | 4 ++-- docs/using-the-api/webhooks/overview.md | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/using-the-api/webhooks/create-consumer.md b/docs/using-the-api/webhooks/create-consumer.md index 5b2496cdc..884fce7bd 100644 --- a/docs/using-the-api/webhooks/create-consumer.md +++ b/docs/using-the-api/webhooks/create-consumer.md @@ -1,7 +1,7 @@ --- title: "Build webhook consumers to subscribe to events" sidebar_label: "Consume webhooks" -description: "Create new webhook consumers and manage existing ones to receive webhooks using the Portal or the API" +description: "Configure new webhook consumers in Codat and manage existing configuration to receive webhook events" --- import Tabs from "@theme/Tabs"; @@ -15,7 +15,7 @@ This consumer must process the event within 15 seconds when it receives a POST r ## Configure webhook consumer -Once you have build your webhook consumer you will need to configure Codat to send the consumer events. +Once you have built your webhook consumer, configure Codat to send events to this consumer. Navigate to **Settings > Webhooks > Events > Configure consumer** and click **Add endpoint** to create a new consumer. Add the endpoint URL that you want to receive the messages, an optional description, and choose the events that this endpoint should listen to. You must specify a least one event type per endpoint. diff --git a/docs/using-the-api/webhooks/overview.md b/docs/using-the-api/webhooks/overview.md index 405ff209b..4283e0c52 100644 --- a/docs/using-the-api/webhooks/overview.md +++ b/docs/using-the-api/webhooks/overview.md @@ -17,10 +17,10 @@ With our webhook service, you can leverage the following benefits: :::note Using our legacy webhooks? -If you have been using our webhooks prior to March 6, 2024, we recommend migrating over to the new service. -Details on how do migrate can be found in our [migration guide](/using-the-api/webhooks/migration-guide). +If you have been using our webhooks before March 6, 2024, we recommend migrating them to the new service. +See how you can migrate in our [migration guide](/using-the-api/webhooks/migration-guide). -You can find the old documentation here: +You can view the old webhook service documentation here: - [View rule types](/using-the-api/webhooks/legacy/core-rules-types) - [Create or update rules](/using-the-api/webhooks/legacy/core-rules-create)