> ## Documentation Index > Fetch the complete documentation index at: https://docs.stackone.com/llms.txt > Use this file to discover all available pages before exploring further. # Get connector event action > Returns the definition of one of the connector event actions — the inbound counterpart of `get_connector_action`, describing how an event the provider sends is processed. Fetch it per event action. ## OpenAPI ````yaml get /v2/connectors/{id}/event_actions/{eventId} openapi: 3.1.0 info: title: StackOne description: The documentation for the StackOne API version: 1.0.0 contact: {} servers: - url: https://api.stackone.com security: [] tags: - name: Accounts description: View and manage linked accounts. - name: Connector Profiles description: View and manage connector profiles for the project. - name: Connectors description: Retrieve metadata for connectors. - name: Webhooks description: Configure and manage webhooks. - name: Data Sync description: View data-sync configs, schedules, and runs. paths: /v2/connectors/{id}/event_actions/{eventId}: get: tags: - Connectors summary: Get connector event action description: >- Returns the definition of one of the connector event actions — the inbound counterpart of `get_connector_action`, describing how an event the provider sends is processed. Fetch it per event action. operationId: get_connector_event_action parameters: - name: id required: true in: path description: >- The connector id, in the form `key[@version][~owner]` (e.g. `hibob@1.2.0~stackone`). schema: type: string - name: eventId required: true in: path description: The id of the event action. schema: type: string - name: version required: false in: query description: >- The connector version to read the action from, overriding any version in the id. Accepts `latest`. Resolved automatically when omitted. schema: type: string nullable: true - name: owner required: false in: query description: >- The owner of the connector version, overriding any owner in the id. Accepts the wildcards `builtin` (global) and `custom` (the organization's own). Resolved automatically when omitted. schema: type: string nullable: true - name: expand required: false in: query description: >- A comma-separated list of additional fields to expand. Supported values: `steps` (the sequence the action runs to fulfil a call) and `result` (how the response body is built from it). Both are `null` unless requested. schema: type: string nullable: true responses: '200': description: The event action was retrieved. content: application/json: schema: $ref: '#/components/schemas/ConnectorActionDetailResource' '400': description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '401': description: Unauthorized access. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '403': description: Forbidden. content: application/json: schema: $ref: '#/components/schemas/ForbiddenResponse' '404': description: Resource not found. content: application/json: schema: $ref: '#/components/schemas/NotFoundResponse' '408': description: The request has timed out. headers: Retry-After: description: A time in seconds after which the request can be retried. schema: type: string content: application/json: schema: $ref: '#/components/schemas/RequestTimedOutResponse' '409': description: Conflict with current state. content: application/json: schema: $ref: '#/components/schemas/ConflictResponse' '422': description: Validation error. content: application/json: schema: $ref: '#/components/schemas/UnprocessableEntityResponse' '429': description: Too many requests. content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsResponse' '500': description: Server error while executing the request. content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' '501': description: This functionality is not implemented. content: application/json: schema: $ref: '#/components/schemas/NotImplementedResponse' '502': description: Bad gateway error. content: application/json: schema: $ref: '#/components/schemas/BadGatewayResponse' security: - basic: [] components: schemas: ConnectorActionDetailResource: type: object properties: id: type: string description: The unique id of the action. label: type: string description: The display label of the action. description: type: string description: The description of the action. action_type: nullable: true description: The operation the action performs on the resource. x-speakeasy-unknown-values: allow allOf: - $ref: '#/components/schemas/ConnectorActionType' schema_type: nullable: true description: >- Whether the action speaks the provider's own schema or a unified one. x-speakeasy-unknown-values: allow allOf: - $ref: '#/components/schemas/ConnectorActionSchemaType' schema: type: string nullable: true description: >- The unified schema the action reads or writes (e.g. `employees`). `null` for native actions. details: type: string nullable: true description: Extended documentation for the action, as Markdown. categories: description: The categories the action belongs to. type: array items: type: string resources: type: string nullable: true description: A link to the provider's documentation for the underlying operation. effects: type: array description: The effects the action has on the external system. x-speakeasy-unknown-values: allow items: $ref: '#/components/schemas/ConnectorActionEffect' required_scopes: description: >- The provider scopes the action requires under every authentication method. Empty when it scopes per method instead — read `authentication[].required_scopes`. type: array items: type: string release_stage: nullable: true description: The release stage of the action. x-speakeasy-unknown-values: allow allOf: - $ref: '#/components/schemas/ConnectorActionReleaseStage' tags: description: The tags of the action. type: array items: type: string authentication: description: >- The authentication methods the action can be run under, with the scopes each needs. type: array items: $ref: '#/components/schemas/ConnectorActionAuthUsageResource' syncable: type: boolean description: Whether the data-sync engine can sync this action. inputs: description: >- The inputs the action accepts, in declaration order. Object inputs nest theirs under `properties`; rules spanning inputs are in `validation_rules`. type: array items: $ref: '#/components/schemas/ConnectorActionInputResource' validation_rules: description: >- Rules spanning several inputs, which the per-input `required` flag cannot express. Apply these too, or a call can still be rejected. type: array items: $ref: '#/components/schemas/ValidationRuleResource' steps: type: object nullable: true additionalProperties: $ref: '#/components/schemas/ConnectorActionStepResource' description: >- The sequence the action runs to fulfil a call, keyed by step id. `null` unless requested with `expand=steps`. result: nullable: true description: >- How the response is built: a response field to expression mapping, or a single expression for the whole body. `null` unless requested with `expand=result`. A mapping referring back to its own ancestor reads as `[cyclic]`. oneOf: - type: string - type: object additionalProperties: true required: - id - label - description - action_type - schema_type - schema - details - categories - resources - effects - required_scopes - release_stage - tags - authentication - syncable - inputs - validation_rules - steps - result BadRequestResponse: type: object properties: statusCode: type: number description: HTTP status code example: 400 message: type: string description: Error message example: Bad Request timestamp: type: string description: Timestamp when the error occurred example: '2023-05-30T00:00:00.000Z' format: date-time data: description: Error details nullable: true allOf: - $ref: '#/components/schemas/UnifiedError' provider_errors: description: List of provider-specific errors nullable: true type: array items: $ref: '#/components/schemas/ProviderError' required: - statusCode - message - timestamp UnauthorizedResponse: type: object properties: statusCode: type: number description: HTTP status code example: 401 message: type: string description: Error message example: Unauthorized timestamp: type: string description: Timestamp when the error occurred example: '2023-05-30T00:00:00.000Z' format: date-time required: - statusCode - message - timestamp ForbiddenResponse: type: object properties: statusCode: type: number description: HTTP status code example: 403 message: type: string description: Error message example: Forbidden resource timestamp: type: string description: Timestamp when the error occurred example: '2023-05-30T00:00:00.000Z' format: date-time required: - statusCode - message - timestamp NotFoundResponse: type: object properties: statusCode: type: number description: HTTP status code example: 404 message: type: string description: Error message example: Not Found timestamp: type: string description: Timestamp when the error occurred example: '2023-05-30T00:00:00.000Z' format: date-time required: - statusCode - message - timestamp RequestTimedOutResponse: type: object properties: statusCode: type: number description: HTTP status code example: 408 message: type: string description: Error message example: Request timed out timestamp: type: string description: Timestamp when the error occurred example: '2023-05-30T00:00:00.000Z' format: date-time required: - statusCode - message - timestamp ConflictResponse: type: object properties: statusCode: type: number description: HTTP status code example: 409 message: type: string description: Error message example: Conflict timestamp: type: string description: Timestamp when the error occurred example: '2023-05-30T00:00:00.000Z' format: date-time required: - statusCode - message - timestamp UnprocessableEntityResponse: type: object properties: statusCode: type: number description: HTTP status code example: 422 message: type: string description: Error message example: Unprocessable Entity timestamp: type: string description: Timestamp when the error occurred example: '2023-05-30T00:00:00.000Z' format: date-time required: - statusCode - message - timestamp TooManyRequestsResponse: type: object properties: statusCode: type: number description: HTTP status code example: 429 message: type: string description: Error message example: Too many requests timestamp: type: string description: Timestamp when the error occurred example: '2023-05-30T00:00:00.000Z' format: date-time required: - statusCode - message - timestamp InternalServerErrorResponse: type: object properties: statusCode: type: number description: HTTP status code example: 500 message: type: string description: Error message example: Internal server error timestamp: type: string description: Timestamp when the error occurred example: '2023-05-30T00:00:00.000Z' format: date-time required: - statusCode - message - timestamp NotImplementedResponse: type: object properties: statusCode: type: number description: HTTP status code example: 501 message: type: string description: Error message example: Not Implemented timestamp: type: string description: Timestamp when the error occurred example: '2023-05-30T00:00:00.000Z' format: date-time required: - statusCode - message - timestamp BadGatewayResponse: type: object properties: statusCode: type: number description: HTTP status code example: 502 message: type: string description: Error message example: Bad Gateway timestamp: type: string description: Timestamp when the error occurred example: '2023-05-30T00:00:00.000Z' format: date-time required: - statusCode - message - timestamp ConnectorActionType: type: string enum: - list - get - create - update - delete - custom - refresh_token - test - event - unknown description: The operation the action performs on the resource. ConnectorActionSchemaType: type: string enum: - native - unified description: Whether the action speaks the provider's own schema or a unified one. ConnectorActionEffect: type: string enum: - read - write - delete - search - execute description: The effects the action has on the external system. ConnectorActionReleaseStage: type: string enum: - preview - beta - ga - deprecated - internal description: The release stage of the action. ConnectorActionAuthUsageResource: type: object properties: type: type: string description: The authentication type (e.g. `oauth2`, `custom`). label: type: string description: The display label of the authentication method. key: type: string description: The key of the authentication method. required_scopes: description: The provider scopes the action requires under this method. nullable: true type: array items: type: string description: type: string description: A description of the authentication requirements. nullable: true required: - type - label - key ConnectorActionInputResource: type: object properties: name: type: string description: The name of the input. description: type: string description: What the input is for. required: type: boolean description: Whether the action requires the input. type: description: The value type of the input. x-speakeasy-unknown-values: allow nullable: true allOf: - $ref: '#/components/schemas/ConnectorActionInputType' in: description: >- Where the input is sent on the provider request. Set on top-level inputs only. x-speakeasy-unknown-values: allow nullable: true allOf: - $ref: '#/components/schemas/ConnectorActionInputLocation' array: type: boolean description: Whether the input accepts a list of values. nullable: true properties: description: >- The members of an object input. Absent — not empty — on an input that appears within itself. nullable: true type: array items: $ref: '#/components/schemas/ConnectorActionInputResource' options: description: The allowed values, for inputs of type `enum`. nullable: true allOf: - $ref: '#/components/schemas/ConnectorActionInputEnumResource' rules: description: The validation constraints on the input. nullable: true allOf: - $ref: '#/components/schemas/ConnectorActionInputRulesResource' variants: description: >- The alternative shapes the input accepts; a value matching any one is valid. nullable: true type: array items: $ref: '#/components/schemas/ConnectorActionInputVariantResource' required: - name - description - required ValidationRuleResource: type: object properties: type: type: string description: The kind of rule. enum: - at_least_one_of - required_if - mutually_exclusive x-speakeasy-unknown-values: allow fields: description: >- The parameters the rule spans, for `at_least_one_of` and `mutually_exclusive`. nullable: true type: array items: type: string field: type: string description: >- The parameter the rule makes conditionally required, for `required_if`. nullable: true condition: allOf: - $ref: '#/components/schemas/ValidationRuleConditionResource' description: When `field` becomes required, for `required_if`. nullable: true error_message: type: string description: The message the action returns when the rule is violated. nullable: true required: - type ConnectorActionStepResource: type: object properties: id: type: string description: The id of the step, unique within the action. description: type: string description: What the step does. nullable: true condition: type: string description: An expression that must hold for the step to run. nullable: true onConditionError: description: >- `true` skips the step, `false` fails the action, `break` stops the rest. oneOf: - type: boolean - type: string enum: - break nullable: true successCriteria: type: string description: An expression that must hold for the step to count as successful. nullable: true ignoreError: type: boolean description: Whether the action continues when this step fails. nullable: true async: type: boolean description: Whether the step runs without the action waiting for it. nullable: true iterator: type: string description: >- The collection the step iterates over. Present on repeating steps only. nullable: true stepFunction: description: The operation the step performs. nullable: true allOf: - $ref: '#/components/schemas/ConnectorActionStepFunctionResource' stepFunctions: description: The operations the step performs in order, for a repeating step. nullable: true type: array items: $ref: '#/components/schemas/ConnectorActionStepFunctionResource' required: - id UnifiedError: type: object properties: statusCode: type: number description: HTTP status code example: 400 nullable: true message: type: string description: Error message example: Bad Request nullable: true headers: type: object description: Response headers example: content-type: application/json x-request-id: 5678c28b211dace4e0a0f9171e6b88c5 nullable: true ProviderError: type: object properties: status: type: number description: HTTP status code of the provider error example: 400 nullable: true url: type: string description: URL that caused the error example: https://api.provider.com/v1/resource nullable: true raw: type: object description: Raw error response from the provider example: message: Invalid input parameters nullable: true headers: type: object description: Response headers example: content-type: application/json x-request-id: 5678c28b211dace4e0a0f9171e6b88c5 nullable: true ConnectorActionInputType: type: string enum: - string - number - boolean - datetime_string - object - enum - unmapped_value - null description: The value type of the input. ConnectorActionInputLocation: type: string enum: - body - query - path - headers - unmapped_value - null description: >- Where the input is sent on the provider request. Set on top-level inputs only. ConnectorActionInputEnumResource: type: object properties: values: description: >- The allowed values, listed inline or resolved from `ref`. Absent when a named enum could not be resolved. nullable: true type: array items: type: string ref: type: string description: >- The shared enum the values came from. Absent when the input lists its values itself. nullable: true ConnectorActionInputRulesResource: type: object properties: min_length: type: number description: The minimum length of a string value. nullable: true max_length: type: number description: The maximum length of a string value. nullable: true pattern: type: string description: A regular expression the value must match. nullable: true format: description: The expected string format. x-speakeasy-unknown-values: allow nullable: true allOf: - $ref: '#/components/schemas/ConnectorActionInputFormat' min: type: number description: The minimum numeric value. nullable: true max: type: number description: The maximum numeric value. nullable: true error_message: type: string description: The message to surface when the value fails these rules. nullable: true ConnectorActionInputVariantResource: type: object properties: type: description: The value type of this variant. x-speakeasy-unknown-values: allow allOf: - $ref: '#/components/schemas/ConnectorActionInputVariantType' description: type: string description: What this variant represents. nullable: true array: type: boolean description: Whether this variant accepts a list of values. nullable: true properties: description: The members of this variant, when it is an object. nullable: true type: array items: $ref: '#/components/schemas/ConnectorActionInputResource' options: description: The allowed values, when this variant is an enum. nullable: true allOf: - $ref: '#/components/schemas/ConnectorActionInputEnumResource' rules: description: The validation constraints on this variant. nullable: true allOf: - $ref: '#/components/schemas/ConnectorActionInputRulesResource' required: - type ValidationRuleConditionResource: type: object properties: field: type: string description: The parameter the condition tests. equals: type: string description: The condition holds when the tested parameter equals this value. nullable: true not_equals: type: string description: >- The condition holds when the tested parameter differs from this value. nullable: true present: type: boolean description: >- The condition holds on the tested parameter being present (or absent). nullable: true required: - field ConnectorActionStepFunctionResource: type: object properties: functionName: type: string description: The step function to run (e.g. `request`, `map_fields`, `typecast`). version: type: string description: The version of the step function. nullable: true params: type: object additionalProperties: true description: >- The arguments the step function runs with. The shape varies by step function, and values may contain `${...}` expressions naming inputs, credentials or the output of earlier steps. An argument referring back to its own ancestor reads as `[cyclic]`. nullable: true required: - functionName ConnectorActionInputFormat: type: string enum: - email - url - uuid - date - datetime - uri - unmapped_value - null description: The expected string format. ConnectorActionInputVariantType: type: string enum: - string - number - boolean - datetime_string - object - enum description: The value type of this variant. securitySchemes: basic: type: http scheme: basic ````