# AGENT_TASK_DETAILS

Endpoint: POST AGENT_TASK_DETAILS
Version: v2
Security: Bearer

## Request fields (application/json):

  - `event_type` (string)
    AGENT_TASK_DETAILS

  - `operationSummary` (object)
    Operation summary for webhook payload

  - `operationSummary.ticketsIssued` (array)
    The tickets issued

  - `operationSummary.ticketsVoided` (array)
    The tickets voided

  - `operationSummary.ticketsRefunded` (array)
    The tickets refunded

  - `operation` (string)
    Agent task operation types
    Enum: "TASK_CREATE", "TASK_UPDATE"

  - `payload` (object)

  - `payload.primaryTraveler` (object)
    Traveler Information

  - `payload.primaryTraveler.userOrgId` (object)
    User and user's organization information.

  - `payload.primaryTraveler.userOrgId.organizationId` (object, required)
    Organization id for traveler.

  - `payload.primaryTraveler.userOrgId.organizationId.id` (string, required)

  - `payload.primaryTraveler.userOrgId.userId` (object, required)
    User identifier

  - `payload.primaryTraveler.userOrgId.tmcBasicInfo` (object)
    TMC related basic information.

  - `payload.primaryTraveler.userOrgId.tmcBasicInfo.contractingTmc` (object, required)
    Contracting TMC is the TMC the user/organization contracted.

  - `payload.primaryTraveler.userOrgId.tmcBasicInfo.contractingTmc.id` (object, required)
    Company ID

  - `payload.primaryTraveler.userOrgId.tmcBasicInfo.contractingTmc.name` (string)

  - `payload.primaryTraveler.userOrgId.tmcBasicInfo.contractingTmc.logo` (object)
    Company logo

  - `payload.primaryTraveler.userOrgId.tmcBasicInfo.contractingTmc.logo.data` (string)
    Example: "6935813e12584abda0e43d71cd2ea260"

  - `payload.primaryTraveler.userOrgId.tmcBasicInfo.contractingTmc.logo.dimensions` (object)
    Image dimensions ie width and height.

  - `payload.primaryTraveler.userOrgId.tmcBasicInfo.contractingTmc.logo.dimensions.height` (integer)
    Example: 120

  - `payload.primaryTraveler.userOrgId.tmcBasicInfo.contractingTmc.logo.dimensions.width` (integer)
    Example: 240

  - `payload.primaryTraveler.userOrgId.tmcBasicInfo.contractingTmc.logo.url` (string)
    Example: "https://static.wixstatic.com/media/73f2e2_6935813e12584abda0e43d71cd2ea260~mv2.png/v1/fill/w_630,h_94,al_c,q_85,usm_0.66_1.00_0.01/Spotnana%403x.webp"

  - `payload.primaryTraveler.userOrgId.tmcBasicInfo.bookingTmc` (object, required)
    Booking TMC is the TMC used for the bookings for the user/organization.

  - `payload.primaryTraveler.userOrgId.organizationAgencyId` (object)
    Agency id for the organization.

  - `payload.primaryTraveler.userOrgId.tmcInfo` (object)
    TMC config information.

  - `payload.primaryTraveler.userOrgId.tmcInfo.id` (object, required)
    TMC id.

  - `payload.primaryTraveler.userOrgId.tmcInfo.primaryServiceProviderTmc` (object, required)
    Primary service provider TMC for the TMC.

  - `payload.primaryTraveler.userOrgId.tmcInfo.primaryServiceProviderTmc.tmcId` (object, required)
    Id of the service provider TMC.

  - `payload.primaryTraveler.userOrgId.tmcInfo.secondaryServiceProviderTmcs` (array)
    Secondary service provider TMCs for the TMC.

  - `payload.primaryTraveler.userOrgId.tmcInfo.secondaryServiceProviderTmcs.supplier` (string, required)
    Supplier for which this service provider should be used.
    Enum: "SABRE", "AMADEUS", "TRAVEL_FUSION", "FARELOGIX_NDC", "ATPCO_NDC", "TRAINLINE", "AVIA", "QBR", "BCD", "QANTAS_HOTELS", "SOUTHWEST", "EXPEDIA", "HOTEL_HUB", "NDC", "MARRIOTT", "CLEARTRIP", "KYTE", "GROUNDSPAN", "SABRE_NDC", "BOOKING_COM", "CARTRAWLER", "PREMIER_INN", "TRAVELODGE"

  - `payload.primaryTraveler.userOrgId.tmcInfo.secondaryServiceProviderTmcs.travelType` (string, required)
    Travel type for which this service provider should be used.
    Enum: "AIR", "HOTEL", "CAR", "RAIL", "LIMO", "MISC", "ALL"

  - `payload.primaryTraveler.userOrgId.tmcInfo.partnerTmcId` (object)
    Useful to identify the clients onboarded by a PARTNER_TMC

  - `payload.primaryTraveler.persona` (string)
    Persona of the user
    Enum: "UNKNOWN_PERSONA", "EMPLOYEE", "GUEST", "PERSONAL", "RELATIVE", "ADHOC"

  - `payload.primaryTraveler.email` (string)
    Example: "example@email.com"

  - `payload.primaryTraveler.name` (object)
    Full name containing first, middle, last (family) names, and suffix.

  - `payload.primaryTraveler.name.family1` (string, required)
    Last (family) name.
    Example: "Gandas"

  - `payload.primaryTraveler.name.family2` (string)
    Example: "FamilyTwo"

  - `payload.primaryTraveler.name.given` (string, required)
    First (given) name.
    Example: "Vichitr"

  - `payload.primaryTraveler.name.middle` (string)
    Middle name.
    Example: "Kumar"

  - `payload.primaryTraveler.name.suffix` (string)
    Suffix used with the name. For example SR or JR.
    Enum: "NAME_SUFFIX_UNKNOWN", "SR", "JR", "MD", "PHD", "II", "III", "IV", "DO", "ATTY", "V", "VI", "ESQ", "DC", "DDS", "VM", "JD", "SECOND", "THIRD"

  - `payload.primaryTraveler.name.preferred` (string)
    Informal preferred name added by traveler. This is not used on any PNR or tickets
    Example: "Don"

  - `payload.primaryTraveler.profilePicture` (object)
    An image with meta data. Either the data or url property must be supplied to load the image.

  - `payload.primaryTraveler.tier` (string)
    Tier of User.
Note: In default UI, BASIC is displayed as Standard, and SEAT1A is displayed as VIP.
    Enum: "BASIC", "SEAT1A"

  - `payload.primaryTraveler.phoneNumber` (object)
    Properly formatted phone number.

  - `payload.primaryTraveler.phoneNumber.countryCode` (integer)
    two digit country code
    Example: 91

  - `payload.primaryTraveler.phoneNumber.countryCodeSource` (string)
    Enum: "UNSPECIFIED", "FROM_NUMBER_WITH_PLUS_SIGN", "FROM_NUMBER_WITH_IDD", "FROM_NUMBER_WITHOUT_PLUS_SIGN", "FROM_DEFAULT_COUNTRY"

  - `payload.primaryTraveler.phoneNumber.extension` (string)
    phone number extension
    Example: "222"

  - `payload.primaryTraveler.phoneNumber.isoCountryCode` (string)
    ISO alpha-2 code
    Example: "IN"

  - `payload.primaryTraveler.phoneNumber.italianLeadingZero` (boolean)
    Example: true

  - `payload.primaryTraveler.phoneNumber.nationalNumber` (integer)
    Example: 8150

  - `payload.primaryTraveler.phoneNumber.numberOfLeadingZeros` (integer)
    Example: 1

  - `payload.primaryTraveler.phoneNumber.preferredDomesticCarrierCode` (string)
    Example: "7"

  - `payload.primaryTraveler.phoneNumber.rawInput` (string)
    Example: "77777"

  - `payload.primaryTraveler.phoneNumber.type` (string)
    Enum: "UNKNOWN_TYPE", "MOBILE", "LANDLINE"

  - `payload.primaryTraveler.employeeId` (string)
    Employee id of the user

  - `payload.primaryTraveler.isActive` (boolean)
    Whether user profile is active or not.
    Example: true

  - `payload.travelArranger` (object)
    The travel arranger to be contacted (if any).

  - `payload.priority` (string, required)
    Priority of the task
    Enum: "URGENT", "HIGH", "MEDIUM", "LOW", "IGNORE", "NA"

  - `payload.travelStartDate` (object)
    Local date and time in ISO 8601 format.

  - `payload.travelStartDate.iso8601` (string, required)
    Example: "2017-07-21T17:32"

  - `payload.bookingDate` (object)
    Local date and time in ISO 8601 format.

  - `payload.status` (string, required)
    Status of the task.
    Enum: "ACTIVE", "COMPLETED", "ON_HOLD", "SCHEDULED", "OPEN", "UNKNOWN"

  - `payload.assignee` (object)
    The agent who is assigned this task

  - `payload.organization` (object)
    Basic information about the organization

  - `payload.organization.orgId` (string)
    Example: "4974a66b-7493-4f41-908c-58ba81093947"

  - `payload.organization.orgName` (string, required)
    Example: "Spotnana"

  - `payload.organization.emailDomains` (array)
    List of the email domains

  - `payload.source` (string, required)
    Enum: "UNKNOWN_SOURCE", "SABRE", "TRAVEL_FUSION", "AVIA", "NDC", "TRAINLINE", "ATPCO_NDC", "FARELOGIX_NDC", "OFFLINE", "CONNEXUS", "ROUTEHAPPY", "AMADEUS", "GIATA", "QBR", "BCD", "QANTAS_HOTELS", "SOUTHWEST", "EXPEDIA", "HOTEL_HUB", "MARRIOTT", "CLEARTRIP", "KYTE", "GROUNDSPAN", "SABRE_NDC", "BOOKING_COM", "CARTRAWLER", "PREMIER_INN", "TRAVELODGE"

  - `payload.bookingTmc` (object)
    Basic information about the organization

  - `payload.contractingTmc` (object)
    Basic information about the organization

  - `payload.tierAtBooking` (string)
    Tier of User.
Note: In default UI, BASIC is displayed as Standard, and SEAT1A is displayed as VIP.
    Enum: "BASIC", "SEAT1A"

  - `payload.taskOrigin` (string)
    Origin of task.
    Enum: "SUPPLIER", "SEAT1A", "BOOKING_ENGINE", "MANUAL", "MID_OFFICE", "UNUSED_TICKET_TRACKING"

  - `payload.events` (array)
    Information about all the events within task.

  - `payload.events.id` (string)
    Unique task event ID.
    Example: "065c77fa-900c-11ec-9eeb-0242ac170003"

  - `payload.events.description` (string)
    Description of the event.
    Example: "PNR modified by airline that contains corporate travel policy"

  - `payload.events.metadata` (string)
    Metadata of the event.
    Example: "Q:20"

  - `payload.events.taskMetadata` (any)

  - `payload.events.createdAt` (object)
    ISO8601 UTC Date Time

  - `payload.events.queueNumber` (integer)
    Queue Number.
    Example: 10

  - `payload.events.queueDescription` (string)
    Description of the queue.
    Example: "PNR modified by airline that contains corporate travel policy"

  - `payload.assignedGroup` (object)
    Basic details related to agent group.

  - `payload.assignedGroup.id` (string)
    Agent group id.

  - `payload.assignedGroup.name` (string, required)
    Name of the agent group.

  - `payload.assignedGroup.description` (string, required)
    Description of the agent group.

  - `payload.assignedGroup.isDefault` (boolean)
    True if group is default group for the tmc.

  - `payload.assignedAgent` (object)
    Agent details.

  - `payload.assignedAgent.role` (string)
    Role of user in the organization
    Example: "SYSTEM_ADMIN"

  - `payload.assignedAgent.title` (string)
    Designation of user in the organization
    Example: "Human Resources"

  - `payload.assignedAgent.office` (string)
    Office name where user is working
    Example: "London or New York"

  - `payload.assignedAgent.userBasicInfo` (object, required)
    Basic user information.

  - `payload.assignedAgent.assignedGroups` (array)
    Information about all the groups agent is assigned to.

  - `payload.assignedAgent.assignedTasks` (array)
    Information about all the tasks assigned to the agent.

  - `payload.assignedAgent.assignedTasks.id` (string, required)
    Task ID.

  - `payload.assignedAgent.assignedTasks.sourcePnrId` (string)
    Source PNR ID associated to the task.

  - `payload.assignedAgent.assignedTasks.eventCount` (integer)
    Number of task events.

  - `payload.assignedAgent.assignedTasks.tripId` (string)
    Trip ID associated to the task.

  - `payload.assignedAgent.assignedTasks.type` (string)
    Type of task.
    Example: "Schedule change"

  - `payload.assignedAgent.assignedTasks.description` (string)
    Task type description.

  - `payload.assignedAgent.availabilityStatus` (string)
    Availability status of agent.
    Enum: "UNKNOWN_AVAILABILITY_STATUS", "AVAILABLE", "OFFLINE", "ON_BREAK"

  - `payload.taskDuration` (object)
    Represents a duration of time with specific units of time.

  - `payload.taskDuration.iso8601` (string)
    Durations define the amount of intervening time in a time interval and are represented by the
format P[n]Y[n]M[n]DT[n]H[n]M[n]S.
The [n] is replaced by the value for each of the date and time elements that follow the [n].
Leading zeros are not required. The capital letters P, Y, M, W, D, T, H, M, and S are
designators for each of the date and time elements and are not replaced. P is the duration
designator (for period) placed at the start of the duration representation.
Y is the year designator.
M is the month designator.
W is the week designator.
D is the day designator.
T is the time designator.
H is the hour designator.
M is the minute designator.
S is the second designator and can include decimal digits with arbitrary precision.
    Example: "PT19H55M"

  - `payload.assignedAgentBasicInfo` (object)
    Agent Basic information details.

  - `payload.description` (string)
    Example: "Approval timed out"

  - `timestamp` (string)
    Timestamp when the event was published

  - `audience` (object)
    Audience for whom this webhook payload is intended

  - `audience.organizationId` (string)
    Organization ID

  - `audience.contractingTmcId` (string)
    Contracting TMC ID

  - `audience.bookingTmcId` (string)
    Booking TMC ID


## Response 200 fields