Skip to content

Latest commit

 

History

History
373 lines (232 loc) · 13.6 KB

WebhookTriggersApi.md

File metadata and controls

373 lines (232 loc) · 13.6 KB
Raw

{{classname}}

All URIs are relative to https://app.harness.io/gateway

Method HTTP request Description
FetchWebhookDetails Get /pipeline/api/webhook/triggerProcessingDetails Gets webhook event processing details for input eventId.
GetActionsList Get /pipeline/api/webhook/actions Get all supported actions for event type and source.
GetBitbucketPRActions Get /pipeline/api/webhook/bitbucketPRActions Gets all supported Bitbucket PR event actions.
GetBitbucketTriggerEvents Get /pipeline/api/webhook/bitbucketTriggerEvents Gets all supported Bitbucket trigger events.
GetGitTriggerEventDetails Get /pipeline/api/webhook/gitTriggerEventDetails Gets trigger git actions for each supported event.
GetGithubIssueCommentActions Get /pipeline/api/webhook/githubIssueCommentActions Gets all supported Github Issue comment event actions
GetGithubPRActions Get /pipeline/api/webhook/githubPRActions Gets all supported Github PR event actions
GetGithubTriggerEvents Get /pipeline/api/webhook/githubTriggerEvents Gets all supported Github trigger events.
GetGitlabPRActions Get /pipeline/api/webhook/gitlabPRActions Gets all supported GitLab PR event actions.
GetGitlabTriggerEvents Get /pipeline/api/webhook/gitlabTriggerEvents Gets all supported Gitlab trigger events.
GetSourceRepos Get /pipeline/api/webhook/sourceRepos Gets source repo types with all supported events.
GetWebhookTriggerTypes Get /pipeline/api/webhook/webhookTriggerTypes Gets all supported scm webhook type.
PipelineprocessWebhookEvent Post /pipeline/api/webhook/trigger Handles event payload for webhook triggers.
ProcessCustomWebhookEvent Post /pipeline/api/webhook/custom Handles event payload for custom webhook triggers.

FetchWebhookDetails

ResponseDtoWebhookEventProcessingDetails FetchWebhookDetails(ctx, accountIdentifier, eventId) Gets webhook event processing details for input eventId.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
accountIdentifier string
eventId string

Return type

ResponseDtoWebhookEventProcessingDetails

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetActionsList

ResponseDtoListWebhookAction GetActionsList(ctx, sourceRepo, event) Get all supported actions for event type and source.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
sourceRepo string
event string

Return type

ResponseDtoListWebhookAction

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetBitbucketPRActions

ResponseDtoListBitbucketPrAction GetBitbucketPRActions(ctx, ) Gets all supported Bitbucket PR event actions.

Required Parameters

This endpoint does not need any parameter.

Return type

ResponseDtoListBitbucketPrAction

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetBitbucketTriggerEvents

ResponseDtoListBitbucketTriggerEvent GetBitbucketTriggerEvents(ctx, ) Gets all supported Bitbucket trigger events.

Required Parameters

This endpoint does not need any parameter.

Return type

ResponseDtoListBitbucketTriggerEvent

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetGitTriggerEventDetails

ResponseDtoMapStringMapStringListString GetGitTriggerEventDetails(ctx, ) Gets trigger git actions for each supported event.

Required Parameters

This endpoint does not need any parameter.

Return type

ResponseDtoMapStringMapStringListString

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetGithubIssueCommentActions

ResponseDtoListGithubIssueCommentAction GetGithubIssueCommentActions(ctx, ) Gets all supported Github Issue comment event actions

Required Parameters

This endpoint does not need any parameter.

Return type

ResponseDtoListGithubIssueCommentAction

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetGithubPRActions

ResponseDtoListGithubPrAction GetGithubPRActions(ctx, ) Gets all supported Github PR event actions

Required Parameters

This endpoint does not need any parameter.

Return type

ResponseDtoListGithubPrAction

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetGithubTriggerEvents

ResponseDtoListGithubTriggerEvent GetGithubTriggerEvents(ctx, ) Gets all supported Github trigger events.

Required Parameters

This endpoint does not need any parameter.

Return type

ResponseDtoListGithubTriggerEvent

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetGitlabPRActions

ResponseDtoListGitlabPrAction GetGitlabPRActions(ctx, ) Gets all supported GitLab PR event actions.

Required Parameters

This endpoint does not need any parameter.

Return type

ResponseDtoListGitlabPrAction

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetGitlabTriggerEvents

ResponseDtoListGitlabTriggerEvent GetGitlabTriggerEvents(ctx, ) Gets all supported Gitlab trigger events.

Required Parameters

This endpoint does not need any parameter.

Return type

ResponseDtoListGitlabTriggerEvent

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSourceRepos

ResponseDtoMapWebhookSourceRepoListWebhookEvent GetSourceRepos(ctx, ) Gets source repo types with all supported events.

Required Parameters

This endpoint does not need any parameter.

Return type

ResponseDtoMapWebhookSourceRepoListWebhookEvent

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetWebhookTriggerTypes

ResponseDtoListWebhookTriggerType GetWebhookTriggerTypes(ctx, ) Gets all supported scm webhook type.

Required Parameters

This endpoint does not need any parameter.

Return type

ResponseDtoListWebhookTriggerType

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PipelineprocessWebhookEvent

ResponseDtoString PipelineprocessWebhookEvent(ctx, body, accountIdentifier, optional) Handles event payload for webhook triggers.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body string
accountIdentifier string
optional *WebhookTriggersApiPipelineprocessWebhookEventOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a WebhookTriggersApiPipelineprocessWebhookEventOpts struct

Name Type Description Notes

orgIdentifier | optional.| | projectIdentifier | optional.| |

Return type

ResponseDtoString

Authorization

ApiKey

HTTP request headers

  • Content-Type: application/json, application/yaml, text/plain
  • Accept: application/json, application/yaml, text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ProcessCustomWebhookEvent

ResponseDtoString ProcessCustomWebhookEvent(ctx, body, accountIdentifier, orgIdentifier, projectIdentifier, optional) Handles event payload for custom webhook triggers.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body string
accountIdentifier string
orgIdentifier string
projectIdentifier string
optional *WebhookTriggersApiProcessCustomWebhookEventOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a WebhookTriggersApiProcessCustomWebhookEventOpts struct

Name Type Description Notes

pipelineIdentifier | optional.| | triggerIdentifier | optional.| |

Return type

ResponseDtoString

Authorization

ApiKey

HTTP request headers

  • Content-Type: application/json, application/yaml, text/plain
  • Accept: application/json, application/yaml, text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]