MCP Webhooks

https://mycarrierpackets.com/Webhooks/Documentation/
Admin
MCP Webhooks enables real-time event notifications via HTTPS to notify applications when...
Tokens:4,150
Snippets:13
Trust Score:9.4
Update:11 months ago
Show doc for...
Tokens:
Raw
### Carrier User Verification Completed Event Payload Example

Source: https://mycarrierpackets.com/Webhooks/Documentation/index

This JSON payload represents an example of the carrier.user_verification.completed event. It includes details about the user, the carrier, and the customer involved in the verification process.

```json
{
    "eventType": "carrier.user_verification.completed",
    "eventDateTime": "2025-05-01T18:21:31.2784222Z",
    "eventData": {
        "userVerificationDetail": {
            "firstName": "FirstName",
            "lastName": "LastName",
            "phoneNumber": "(888) 888-8888",
            "role": "Driver",
            "otherRole": null,
            "verificationStatus": "Verified",
            "verificationDatetime": "2025-05-01T18:21:30.8445657Z"
        },
        "carrier": {
            "dotNumber": 9999997,
            "docketNumber": "MC9999997",
            "legalName": "MCP TEST CARRIER 9999997",
            "dbaName": null
        },
        "customer": {
            "customerID": 6,
            "companyName": "MCP Test Customer"
        }
    }
}
```

--------------------------------

### Carrier Packet Completed Event Payload Example

Source: https://mycarrierpackets.com/Webhooks/Documentation/index

An example JSON payload for the 'carrier.packet.completed' event. This event signifies a carrier successfully completing an MCP online packet. The 'eventData' field contains details about the agreement, carrier, and customer involved.

```json
{
    "eventType": "carrier.packet.completed",
    "eventDateTime": "2025-04-29T22:16:41.5102923Z",
    "eventData": {
        "agreement": {
            "signatureDate": "2025-04-29T22:16:20.6352903",
            "signaturePerson": "MCP Test Carrier",
            "signaturePersonTitle": "President",
            "signaturePersonEmail": "test9999997@test.com",
            "signaturePersonPhoneNumber": "9999999999",
            "agreementImageBlobName": "company-agreement/6/b7453f55-3f3b-454d-8726-89f746082a06",
            "ipAddress": {
                "address": "127.0.0.1",
                "city": "New York City",
                "region": "New York",
                "country": "United States of America"
            },
            "geolocation": {
                "latitude": 34.0544,
                "longitude": -118.244,
                "error": null,
                "method": "IPAddress"
            }
        },
        "carrier": {
            "dotNumber": 9999997,
            "docketNumber": "MC9999997",
            "legalName": "MCP TEST CARRIER 9999997",
            "dbaName": null
        },
        "customer": {
            "customerID": 6,
            "companyName": "MCP Test Customer"
        }
    }
}
```

--------------------------------

### Carrier VIN Verification Completed Event Payload Example

Source: https://mycarrierpackets.com/Webhooks/Documentation/index

Example JSON payload for the carrier.vin_verification.completed event. This event is triggered when a carrier successfully submits a VIN image for verification. The payload contains details about the VIN, the upload location, and the verification status. No external libraries are strictly required for parsing this JSON.

```json
{
    "eventType": "carrier.vin_verification.completed",
    "eventDateTime": "2025-05-01T15:57:12.6350582Z",
    "eventData": {
        "vinVerificationDetail": {
            "imageUploadedByFirstName": "FirstName",
            "imageUploadedByLastName": "LastName",
            "imageUploadedDateTime": "2025-05-01T15:57:05.2815289Z",
            "imageUploadedIPAddress": {
                "address": "127.0.0.1",
                "city": "Arlington",
                "region": "Virginia",
                "country": "United States of America"
            },
            "imageUploadedGeolocation": {
                "latitude": 34.0544,
                "longitude": -118.244,
                "error": null,
                "method": "IPAddress"
            },
            "vin": "3AKJGLD55ESFW7639",
            "vinVerificationStatus": "VINBelongsToAnotherCarrier",
            "otherDOTNumber": 3083762
        },
        "carrier": {
            "dotNumber": 9999997,
            "docketNumber": "MC9999997",
            "legalName": "MCP TEST CARRIER 9999997",
            "dbaName": null
        },
        "customer": {
            "customerID": 6,
            "companyName": "MCP Test Customer"
        }
    }
}
```

--------------------------------

### Verify Webhook Signature with C#

Source: https://mycarrierpackets.com/Webhooks/Documentation/index

Example code in C# to compute the HMAC SHA256 hash of a webhook request body. This is used to verify that the webhook originated from MyCarrierPackets and has not been tampered with. It requires the request body and the webhook secret as input.

```csharp
using System.Security.Cryptography;
using System.Text;

namespace Test
{
    public class MyHmac
    {
        private string CreateToken(string message, string secret)
        {
            Encoding encoding = new System.Text.UTF8Encoding();
            byte[] keyByte = encoding.GetBytes(secret);
            byte[] messageBytes = encoding.GetBytes(message);

            using (HMACSHA256 cryptographer = new HMACSHA256(keyByte))
            {
                byte[] hashmessage = cryptographer.ComputeHash(messageBytes);
                string computedHash = BitConverter.ToString(hashmessage).Replace("-", string.Empty).ToLowerInvariant();
                return computedHash;
            }
        }
    }
}
```

--------------------------------

### Carrier Incident Report Retracted Event Payload Example

Source: https://mycarrierpackets.com/Webhooks/Documentation/index

Example JSON payload for the carrier.incident_report.retracted event. This event signifies that a previously filed incident report for a carrier has been retracted. The payload includes details about the incident, the reporting party, and the carrier involved. It does not require specific external dependencies for parsing.

```json
{
    "eventType": "carrier.incident_report.retracted",
    "eventDateTime": "2025-04-23T06:27:36.3903875Z",
    "eventData": {
        "incidentReport": {
            "incidentDate": "04/22/2025",
            "originCity": "Salt Lake City",
            "originStateProvinceName": "UT",
            "originCountryName": "United States",
            "destinationCity": "Lincoln",
            "destinationStateProvinceName": "NE",
            "destinationCountryName": "United States",
            "reportedByCompany": "MCP Test Company",
            "carrierEmails": "test9999997@test.com",
            "createdBy": "MCP Test User",
            "createdDate": "2025-04-23T06:27:14.8587937",
            "modifiedBy": "MCP Test User",
            "modifiedDate": "2025-04-23T06:27:14.8587937",
            "incidentTypes": [
                "Theft or Unjustified Loss of Freight",
                "Wrong Equipment",
                "Operated Under Alias",
                "No Show without Notification",
                "Pickup or Delivery Service Failure"
            ],
            "comments": [
                {
                    "commenterType": "ReportingParty",
                    "commentBy": "MCP Test User",
                    "commentDate": "2025-04-23T06:27:15.0159957",
                    "comment": "Damaged cargo"
                }
            ]
        },
        "carrier": {
            "dotNumber": 9999997,
            "docketNumber": "MC9999997",
            "legalName": "MCP TEST CARRIER 9999997",
            "dbaName": null
        },
        "customer": {
            "customerID": 6,
            "companyName": "MCP Test Customer"
        }
    }
}
```

--------------------------------

### Carrier Incident Report Updated Event Payload Example

Source: https://mycarrierpackets.com/Webhooks/Documentation/index

This JSON payload illustrates the data for the 'carrier.incident_report.updated' event. It mirrors the structure of the created event but signifies that an existing incident report has been modified. The payload includes all details of the incident report, carrier, and customer, reflecting the updated state.

```json
{
    "eventType": "carrier.incident_report.updated",
    "eventDateTime": "2025-04-23T06:27:36.3903875Z",
    "eventData": {
        "incidentReport": {
            "incidentDate": "04/22/2025",
            "originCity": "Salt Lake City",
            "originStateProvinceName": "UT",
            "originCountryName": "United States",
            "destinationCity": "Lincoln",
            "destinationStateProvinceName": "NE",
            "destinationCountryName": "United States",
            "reportedByCompany": "MCP Test Company",
            "carrierEmails": "test9999997@test.com",
            "createdBy": "MCP Test User",
            "createdDate": "2025-04-23T06:27:14.8587937",
            "modifiedBy": "MCP Test User",
            "modifiedDate": "2025-04-23T06:27:14.8587937",
            "incidentTypes": [
                "Theft or Unjustified Loss of Freight",
                "Wrong Equipment",
                "Operated Under Alias",
                "No Show without Notification",
                "Pickup or Delivery Service Failure"
            ],
            "comments": [
                {
                    "commenterType": "ReportingParty",
                    "commentBy": "MCP Test User",
                    "commentDate": "2025-04-23T06:27:15.0159957",
                    "comment": "Damaged cargo"
                }
            ]
        },
        "carrier": {
            "dotNumber": 9999997,
            "docketNumber": "MC9999997",
            "legalName": "MCP TEST CARRIER 9999997",
            "dbaName": null
        },
        "customer": {
            "customerID": 6,
            "companyName": "MCP Test Customer"
        }
    }
}
```

--------------------------------

### Carrier Incident Report Created Event Payload Example

Source: https://mycarrierpackets.com/Webhooks/Documentation/index

This JSON payload represents the data structure for the 'carrier.incident_report.created' event. It details information about an incident report, including its origin, destination, reporting details, incident types, comments, and associated carrier and customer information. This event is triggered when a new incident report is created.

```json
{
    "eventType": "carrier.incident_report.created",
    "eventDateTime": "2025-04-23T06:27:36.3903875Z",
    "eventData": {
        "incidentReport": {
            "incidentDate": "04/22/2025",
            "originCity": "Salt Lake City",
            "originStateProvinceName": "UT",
            "originCountryName": "United States",
            "destinationCity": "Lincoln",
            "destinationStateProvinceName": "NE",
            "destinationCountryName": "United States",
            "reportedByCompany": "MCP Test Company",
            "carrierEmails": "test9999997@test.com",
            "createdBy": "MCP Test User",
            "createdDate": "2025-04-23T06:27:14.8587937",
            "modifiedBy": "MCP Test User",
            "modifiedDate": "2025-04-23T06:27:14.8587937",
            "incidentTypes": [
                "Theft or Unjustified Loss of Freight",
                "Wrong Equipment",
                "Operated Under Alias",
                "No Show without Notification",
                "Pickup or Delivery Service Failure"
            ],
            "comments": [
                {
                    "commenterType": "ReportingParty",
                    "commentBy": "MCP Test User",
                    "commentDate": "2025-04-23T06:27:15.0159957",
                    "comment": "Damaged cargo"
                }
            ]
        },
        "carrier": {
            "dotNumber": 9999997,
            "docketNumber": "MC9999997",
            "legalName": "MCP TEST CARRIER 9999997",
            "dbaName": null
        },
        "customer": {
            "customerID": 6,
            "companyName": "MCP Test Customer"
        }
    }
}
```
Tokens:
Raw