Skip to content

Commit 57146d7

Browse files
committed
integrations & errors
1 parent 7ea9a92 commit 57146d7

File tree

1 file changed

+69
-38
lines changed

1 file changed

+69
-38
lines changed

settings.mdx

Lines changed: 69 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -665,174 +665,201 @@ This section contains the full reference for the `docs.json` file.
665665
### Integrations
666666

667667
<ResponseField name="integrations" type="object">
668-
Configurations for official integrations
668+
Third-party integrations.
669669

670670
<Expandable title="Integrations">
671671
<ResponseField name="amplitude" type="object">
672+
Amplitude analytics integration.
672673

673674
<Expandable title="Amplitude">
674675
<ResponseField name="apiKey" type="string" required>
675-
The API key for Amplitude.
676+
Your Amplitude API key.
676677
</ResponseField>
677678
</Expandable>
678679
</ResponseField>
679680
<ResponseField name="clearbit" type="object">
680-
681+
Clearbit data enrichment integration.
682+
681683
<Expandable title="Clearbit">
682684
<ResponseField name="publicApiKey" type="string" required>
683-
The public API key for Clearbit.
685+
Your Clearbit API key.
684686
</ResponseField>
685687
</Expandable>
686688
</ResponseField>
687689
<ResponseField name="fathom" type="object">
688-
690+
Fathom analytics integration.
691+
689692
<Expandable title="Fathom">
690693
<ResponseField name="siteId" type="string" required>
691-
The site ID for Fathom.
694+
Your Fathom site ID.
692695
</ResponseField>
693696
</Expandable>
694697
</ResponseField>
695698
<ResponseField name="frontchat" type="object">
696-
699+
Front chat integration.
700+
697701
<Expandable title="Frontchat">
698702
<ResponseField name="snippetId" type="string" required>
703+
Your Front chat snippet ID.
699704

700705
Minimum length: 6
701706
</ResponseField>
702707
</Expandable>
703708
</ResponseField>
704709
<ResponseField name="ga4" type="object">
705-
710+
Google Analytics 4 integration.
711+
706712
<Expandable title="Ga4">
707713
<ResponseField name="measurementId" type="string matching ^G" required>
708-
714+
Your Google Analytics 4 measurement ID.
715+
709716
Must match pattern: ^G
710717
</ResponseField>
711718
</Expandable>
712719
</ResponseField>
713720
<ResponseField name="gtm" type="object">
714-
721+
Google Tag Manager integration.
722+
715723
<Expandable title="Gtm">
716724
<ResponseField name="tagId" type="string matching ^G" required>
717-
725+
Your Google Tag Manager tag ID.
726+
718727
Must match pattern: ^G
719728
</ResponseField>
720729
</Expandable>
721730
</ResponseField>
722731
<ResponseField name="heap" type="object">
723-
732+
Heap analytics integration.
733+
724734
<Expandable title="Heap">
725735
<ResponseField name="appId" type="string" required>
726-
The app ID for Heap.
736+
Your Heap app ID.
727737
</ResponseField>
728738
</Expandable>
729739
</ResponseField>
730740
<ResponseField name="hotjar" type="object">
731-
741+
Hotjar integration.
742+
732743
<Expandable title="Hotjar">
733744
<ResponseField name="hjid" type="string" required>
734-
The Hotjar ID.
745+
Your Hotjar ID.
735746
</ResponseField>
736747
<ResponseField name="hjsv" type="string" required>
737-
The Hotjar script version.
748+
Your Hotjar script version.
738749
</ResponseField>
739750
</Expandable>
740751
</ResponseField>
741752
<ResponseField name="intercom" type="object">
742-
753+
Intercom integration.
754+
743755
<Expandable title="Intercom">
744756
<ResponseField name="appId" type="string" required>
745-
757+
Your Intercom app ID.
758+
746759
Minimum length: 6
747760
</ResponseField>
748761
</Expandable>
749762
</ResponseField>
750763
<ResponseField name="koala" type="object">
751-
764+
Koala integration.
765+
752766
<Expandable title="Koala">
753767
<ResponseField name="publicApiKey" type="string" required>
754-
768+
Your Koala public API key.
769+
755770
Minimum length: 2
756771
</ResponseField>
757772
</Expandable>
758773
</ResponseField>
759774
<ResponseField name="logrocket" type="object">
760-
775+
LogRocket integration.
776+
761777
<Expandable title="Logrocket">
762778
<ResponseField name="appId" type="string" required>
763-
The app ID for Logrocket.
779+
Your LogRocket app ID.
764780
</ResponseField>
765781
</Expandable>
766782
</ResponseField>
767783
<ResponseField name="mixpanel" type="object">
784+
Mixpanel integration.
768785

769786
<Expandable title="Mixpanel">
770787
<ResponseField name="projectToken" type="string" required>
771-
The project token for Mixpanel.
788+
Your Mixpanel project token.
772789
</ResponseField>
773790
</Expandable>
774791
</ResponseField>
775792
<ResponseField name="osano" type="object">
776-
793+
Osano integration.
794+
777795
<Expandable title="Osano">
778796
<ResponseField name="scriptSource" type="string" required>
779-
The script source for Osano.
797+
Your Osano script source.
780798
</ResponseField>
781799
</Expandable>
782800
</ResponseField>
783801
<ResponseField name="pirsch" type="object">
784-
802+
Pirsch analytics integration.
803+
785804
<Expandable title="Pirsch">
786805
<ResponseField name="id" type="string" required>
787-
The ID for Pirsch.
806+
Your Pirsch ID.
788807
</ResponseField>
789808
</Expandable>
790809
</ResponseField>
791810
<ResponseField name="posthog" type="object">
792-
811+
PostHog integration.
812+
793813
<Expandable title="Posthog">
794814
<ResponseField name="apiKey" type="string matching ^phc\_" required>
795-
815+
Your PostHog API key.
816+
796817
Must match pattern: ^phc\_
797818
</ResponseField>
798819
<ResponseField name="apiHost" type="string (uri)">
799-
The API host for Posthog.
820+
Your PostHog API host.
800821
</ResponseField>
801822
</Expandable>
802823
</ResponseField>
803824
<ResponseField name="plausible" type="object">
804-
825+
Plausible analytics integration.
826+
805827
<Expandable title="Plausible">
806828
<ResponseField name="domain" type="string" required>
807-
The domain for Plausible.
829+
Your Plausible domain.
808830
</ResponseField>
809831
<ResponseField name="server" type="string">
810-
The server for Plausible.
832+
Your Plausible server.
811833
</ResponseField>
812834
</Expandable>
813835
</ResponseField>
814836
<ResponseField name="segment" type="object">
837+
Segment integration.
838+
815839
<Expandable title="Segment">
816840
<ResponseField name="key" type="string" required>
817-
The key for Segment.
841+
Your Segment key.
818842
</ResponseField>
819843
</Expandable>
820844
</ResponseField>
821-
822845
<ResponseField name="telemetry" type="object">
846+
Telemetry settings.
847+
823848
<Expandable title="Telemetry">
824849
<ResponseField name="enabled" type="boolean">
825850
Whether to enable telemetry.
826851
</ResponseField>
827852
</Expandable>
828853
</ResponseField>
829854
<ResponseField name="cookies" type="object">
855+
Cookie settings.
856+
830857
<Expandable title="Cookies">
831858
<ResponseField name="key" type="string">
832-
The key for cookies.
859+
Key for cookies.
833860
</ResponseField>
834861
<ResponseField name="value" type="string">
835-
The value for cookies.
862+
Value for cookies.
836863
</ResponseField>
837864
</Expandable>
838865
</ResponseField>
@@ -842,11 +869,15 @@ This section contains the full reference for the `docs.json` file.
842869
### Errors
843870

844871
<ResponseField name="errors" type="object">
872+
Error handling settings.
873+
845874
<Expandable title="Errors">
846875
<ResponseField name="404" type="object">
876+
404 "Page not found" error handling.
877+
847878
<Expandable title="404">
848879
<ResponseField name="redirect" type="boolean">
849-
Whether to redirect to the home page, if the page is not found
880+
Whether to automatically redirect to the home page when a page is not found.
850881
</ResponseField>
851882
</Expandable>
852883
</ResponseField>

0 commit comments

Comments
 (0)