{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml","oas-v1/openapi.json":"oas-v1/openapi.json"},"props":{"metadata":{"markdoc":{"tagList":["openapi-code-sample"]},"type":"markdown"},"seo":{"title":"Getting started","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":["openapi"],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"getting-started","__idx":0},"children":["Getting started"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"prerequisites","__idx":1},"children":["Prerequisites"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A Hook account at ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://app.hook.co"},"children":["app.hook.co"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["An API token — create one from your ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://app.hook.co/profile/tokens"},"children":["token settings"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"base-url","__idx":2},"children":["Base URL"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All API requests are made to:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"https://api.hook.co/{version}\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"authentication","__idx":3},"children":["Authentication"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Include your token in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}," header of every request:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"Authorization: Bearer <your-token>\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"make-your-first-request","__idx":4},"children":["Make your first request"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To verify your token is working, call the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["getCurrentMember"]}," endpoint, which returns the user associated with your token:"]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-v1/openapi.json","operationId":"getCurrentMember","parameters":{},"environments":{}},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"next-steps","__idx":5},"children":["Next steps"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Read the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/authentication"},"children":["Authentication"]}," guide for details on token permissions and expiry"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Review the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/rate-limiting"},"children":["Rate Limiting"]}," guide to understand API usage limits"]}]}]},"headings":[{"value":"Getting started","id":"getting-started","depth":1},{"value":"Prerequisites","id":"prerequisites","depth":2},{"value":"Base URL","id":"base-url","depth":2},{"value":"Authentication","id":"authentication","depth":2},{"value":"Make your first request","id":"make-your-first-request","depth":2},{"value":"Next steps","id":"next-steps","depth":2}],"frontmatter":{"seo":{"title":"Getting started"}},"lastModified":"2026-04-08T10:58:18.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/getting-started","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}