{ "name": "TriggerGithubDispatchEvent", "fully_qualified_name": "GithubApi.TriggerGithubDispatchEvent@0.1.0", "description": "Triggers a GitHub repository dispatch event.\n\nUse this tool to activate a webhook event called `repository_dispatch` to trigger a GitHub Actions workflow or GitHub App webhook. It requires write access to the repository via personal access tokens or GitHub App permissions. You can include additional data using `client_payload` to pass on extra information needed by your workflow.", "toolkit": { "name": "ArcadeGithubApi", "description": null, "version": "0.1.0" }, "input": { "parameters": [ { "name": "repository_owner", "required": true, "description": "Specify the GitHub username or organization name that owns the repository. This is not case-sensitive.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The account owner of the repository. The name is not case sensitive." }, "inferrable": true, "http_endpoint_parameter_name": "owner" }, { "name": "repository_name", "required": true, "description": "The name of the repository. This is not case sensitive and determines which repository's dispatch event will be triggered.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The name of the repository. The name is not case sensitive." }, "inferrable": true, "http_endpoint_parameter_name": "repo" }, { "name": "dispatch_event_details", "required": true, "description": "JSON object containing `event_type` and optional `client_payload` with extra info for the webhook. `event_type` is a custom name for the event, up to 100 characters. `client_payload` is a JSON with up to 10 properties for additional workflow data.", "value_schema": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "client_payload": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10." }, "event_type": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "A custom webhook event name. Must be 100 characters or fewer." } }, "inner_properties": null, "description": "" }, "inferrable": true, "http_endpoint_parameter_name": "requestBody" } ] }, "output": { "description": "Response from the API endpoint 'repos/create-dispatch-event'.", "available_modes": [ "value", "error", "null" ], "value_schema": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": null } }, "requirements": { "authorization": { "provider_id": "arcade-github", "provider_type": "oauth2", "id": null, "oauth2": null }, "secrets": [ { "key": "GIT_SERVER_URL" } ], "metadata": null }, "deprecation_message": null, "metadata": { "object_type": "api_wrapper_tool", "version": "1.1.0", "description": "Tools that enable LLMs to interact directly with the GitHub API." }, "http_endpoint": { "metadata": { "object_type": "http_endpoint", "version": "1.2.0", "description": "" }, "url": "{git_server_url}/api/v3/repos/{owner}/{repo}/dispatches", "http_method": "POST", "headers": {}, "parameters": [ { "name": "owner", "tool_parameter_name": "repository_owner", "description": "The account owner of the repository. The name is not case sensitive.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The account owner of the repository. The name is not case sensitive." }, "accepted_as": "path", "required": true, "deprecated": false, "default": null, "documentation_urls": [] }, { "name": "repo", "tool_parameter_name": "repository_name", "description": "The name of the repository. The name is not case sensitive.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The name of the repository. The name is not case sensitive." }, "accepted_as": "path", "required": true, "deprecated": false, "default": null, "documentation_urls": [] }, { "name": "requestBody", "tool_parameter_name": "dispatch_event_details", "description": "", "value_schema": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "client_payload": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10." }, "event_type": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "A custom webhook event name. Must be 100 characters or fewer." } }, "inner_properties": null, "description": "" }, "accepted_as": "body", "required": true, "deprecated": false, "default": null, "documentation_urls": [] } ], "documentation_urls": [], "secrets": [ { "arcade_key": "GIT_SERVER_URL", "parameter_name": "git_server_url", "accepted_as": "path", "formatted_value": null, "description": "", "is_auth_token": false }, { "arcade_key": "auth_token", "parameter_name": "Authorization", "accepted_as": "header", "formatted_value": "Bearer {authorization}", "description": "The OAuth token to use for authentication.", "is_auth_token": true } ], "request_body_spec": "{\n \"content\": {\n \"application/json\": {\n \"examples\": {\n \"default\": {\n \"value\": {\n \"client_payload\": {\n \"integration\": true,\n \"unit\": false\n },\n \"event_type\": \"on-demand-test\"\n }\n }\n },\n \"schema\": {\n \"properties\": {\n \"client_payload\": {\n \"additionalProperties\": true,\n \"description\": \"JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10.\",\n \"maxProperties\": 10,\n \"type\": \"object\"\n },\n \"event_type\": {\n \"description\": \"A custom webhook event name. Must be 100 characters or fewer.\",\n \"maxLength\": 100,\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"event_type\"\n ],\n \"type\": \"object\"\n }\n }\n },\n \"required\": true\n}", "use_request_body_schema_mode": true, "validate_request_body_schema": true } }