---
title: "Report the external incident id for a carrier issue"
method: POST
path: "/v2/carrier-issues/external-ref"
tags: ["Carrier Support"]
---

# Report the external incident id for a carrier issue

`POST /v2/carrier-issues/external-ref`

## Request

- Base URL: `https://api.prod.goaugment.com`
- URL: `https://api.prod.goaugment.com/v2/carrier-issues/external-ref`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/goaugment/apis/augment-api/docs/v2/carrier-issues/external-ref/post.ts> (a function with typed inputs; its response is checked against the schema)

After you receive a `CARRIER_ISSUE_UPDATED` webhook and create the incident in your own TMS, call this endpoint with the `carrierIssueId` from that webhook and your incident id (`externalId`). Augment stores the correlation so subsequent `CARRIER_ISSUE_UPDATED` events for the same issue include your `externalId` — letting you update the existing incident in place instead of creating a duplicate.

The call is idempotent: sending it again for the same `carrierIssueId` just updates the stored `externalId`. It is optional — if you never call it, events keep arriving without an `externalId` and nothing else changes.

## Request body

- CarrierIssueExternalRefRequest: Correlates a carrier issue from a CARRIER_ISSUE_UPDATED webhook with the matching incident id in your TMS.
  - `carrierIssueId` string, required: The correlation token from the CARRIER_ISSUE_UPDATED webhook payload.
  - `externalId` string, required: The incident id in your TMS.

## Response `204`

External reference recorded

## Other responses

- `422`: Invalid payload

---

[API](https://skmtc.dev/goaugment/apis/augment-api.md) - [All operations](https://skmtc.dev/goaugment/apis/augment-api/llms.txt) - [OpenAPI document](https://skmtc.dev/goaugment/apis/augment-api/revisions/b61097634d79?raw)