Skip to content

[Content]: In HTTP Tracking API Source, Authentication section, change guidance to include the writeKey in the payload, and not in the header #4137

Open
@seg-leonelsanches

Description

@seg-leonelsanches

What article on segment.com/docs is affected?

https://segment.com/docs/connections/sources/catalog/libraries/server/http-api/#authentication

What part(s) of the article would you like to see updated?

Per internal docs:

Step 1:
Include WriteKey within event body (in case of single-event requests), or within batch object (in case of batched requests)
POST https://api.segment.io/v1/track (server endpoint)

{
            "writeKey": "<MY_WRITE_KEY>", // top level
            "type": "track",
            "properties": { ...

POST https://api.segment.io/v1/batch (server endpoint)

{
    "writeKey": "<MY_WRITE_KEY>",
    "batch": [
        {
            "type": "track",
            "properties": {

Step 2:
Eliminate WriteKey from HTTPS request header

This comes after JIRA-1107
(viz Migration of Segment server-side logic to favor/utilize WriteKey within TLS-encrypted HTTPS request body).

Additional information

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    OutdatedcontentWhen the bug is about content that needs to get fixedtriaged

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions