All Implemented Interfaces:

io.typeflows.util.Renderable
```
public final class SendRepositoryDispatch
extends BaseRun
                    
```
A workflow step that sends a repository dispatch event via the GitHub API.
Repository dispatch events allow you to trigger workflows in the same repository or external repositories programmatically. This step uses the GitHub REST API to send a POST request with a custom event type and optional payload data. The receiving repository must have a workflow configured to listen for repository_dispatch events with the specified event type. This enables cross-workflow communication and external triggering of automated processes.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`SendRepositoryDispatch.DSL`
`public class`	`SendRepositoryDispatch.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private final String`	`eventType`
`public final String`	`repository`
`public final String`	`shell`
`public final Integer`	`timeoutMinutes`
`public final Boolean`	`continueOnError`
`public final String`	`workingDirectory`
`public final Map<String, Object>`	`env`
`private final String`	`name`
`public final String`	`id`
`public final Expression`	`condition`
`public final Map<String, Object>`	`extra`
`public final static SendRepositoryDispatch.Companion`	`Companion`

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`getEventType()`
`final String`	`getName()`
`final static SendRepositoryDispatch`	`create(String eventType, StrExp token, Map<String, Object> clientPayload, String name, Configure<SendRepositoryDispatch.DSL> step)`	Creates and configures a SendRepositoryDispatch instance.
`final static SendRepositoryDispatch`	`create(String eventType, StrExp token, Map<String, Object> clientPayload, String name)`	Creates and configures a SendRepositoryDispatch instance.
`final static SendRepositoryDispatch`	`create(String eventType, StrExp token, Map<String, Object> clientPayload)`	Creates and configures a SendRepositoryDispatch instance.
`final static SendRepositoryDispatch`	`create(String eventType, StrExp token)`	Creates and configures a SendRepositoryDispatch instance.

Methods inherited from class io.typeflows.github.workflow.step.BaseRun
render
Methods inherited from class io.typeflows.util.Base
equals, hashCode, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - getEventType
```
 final String getEventType()
```
  - getName
```
 final String getName()
```
  - create
```
@JvmOverloads() final static SendRepositoryDispatch create(String eventType, StrExp token, Map<String, Object> clientPayload, String name, Configure<SendRepositoryDispatch.DSL> step)
```
    Creates and configures a SendRepositoryDispatch instance.
    
    Parameters:
    
    eventType - The custom event type that identifies this dispatch
    
    token - GitHub token with repository permissions
    
    clientPayload - Optional payload data to send with the dispatch event
    
    name - Optional name for the step (defaults to "Repository Dispatch")
    
    step - Configuration lambda to customize the step
    
    Returns:
    
    Configured SendRepositoryDispatch instance
  - create
```
@JvmOverloads() final static SendRepositoryDispatch create(String eventType, StrExp token, Map<String, Object> clientPayload, String name)
```
    Creates and configures a SendRepositoryDispatch instance.
    
    Parameters:
    
    eventType - The custom event type that identifies this dispatch
    
    token - GitHub token with repository permissions
    
    clientPayload - Optional payload data to send with the dispatch event
    
    name - Optional name for the step (defaults to "Repository Dispatch")
    
    Returns:
    
    Configured SendRepositoryDispatch instance
  - create
```
@JvmOverloads() final static SendRepositoryDispatch create(String eventType, StrExp token, Map<String, Object> clientPayload)
```
    Creates and configures a SendRepositoryDispatch instance.
    
    Parameters:
    
    eventType - The custom event type that identifies this dispatch
    
    token - GitHub token with repository permissions
    
    clientPayload - Optional payload data to send with the dispatch event
    
    Returns:
    
    Configured SendRepositoryDispatch instance
  - create
```
@JvmOverloads() final static SendRepositoryDispatch create(String eventType, StrExp token)
```
    Creates and configures a SendRepositoryDispatch instance.
    
    Parameters:
    
    eventType - The custom event type that identifies this dispatch
    
    token - GitHub token with repository permissions
    
    Returns:
    
    Configured SendRepositoryDispatch instance

Class SendRepositoryDispatch

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class io.typeflows.github.workflow.step.BaseRun

Methods inherited from class io.typeflows.util.Base

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

getEventType

getName

create

create

create

create