Put Trigger

Prev Next

Available in Classic and VPC

Create or edit a Cloud Functions trigger.

Request

This section describes the request format. The method and URI are as follows:

Method URI
PUT /triggers/{triggerName}

Request headers

For information about the headers common to all Cloud Funtions APIs, see Common Cloud Functions headers.

Request path parameters

The following describes the parameters.

Field Type Required Description
triggerName String Required Trigger name
  • 1 to 50 characters, including English letters, numbers, and special characters "-" and "_", and it can't start with "-"
  • It can't be duplicated with other resource (package, action, trigger) names

Request query parameters

The following describes the parameters.

Field Type Required Description
platform String Optional Platform type
  • vpc | classic (default)
type String Required Trigger type
  • cron | github | insight | object_storage | source_commit
  • Can't be changed after creation

Request body

You can include the following data in the body of your request:

cron trigger

The following describes the request body for cron triggers.

Field Type Required Description
trigger Object Required Information of the trigger
trigger.description String Optional Trigger description (byte)
  • 0 - 3000
trigger.cronOption String Required cron execution option
trigger.parameters Object Optional Default parameters of the trigger
  • JSON in the form of {"key": "value"}
  • Priority of applying parameters when running triggers
    • 1st priority: runtime parameters passed at runtime
    • 2nd priority: default parameters of connected triggers
    • 3rd priority: default parameters in actions
    • 4th priority: default parameters of included packages

GitHub trigger

The following describes the request body for GitHub triggers.

Field Type Required Description
trigger Object Required Information of the trigger
trigger.description String Optional Trigger description
  • 0 - 3000 bytes
trigger.parameters Object Optional Default parameters of the trigger
  • JSON in the form of {"key": "value"}
  • Priority of applying parameters when running triggers
    • 1st priority: runtime parameters passed at runtime
    • 2nd priority: default parameters of connected triggers
    • 3rd priority: default parameters in actions
    • 4th priority: default parameters of included packages
trigger.credentials.username String Required GitHub username
trigger.credentials.accessToken String Required GitHub access token
trigger.credentials.repository String Required GitHub repository
  • Enter the repository name or in the format organization/repository name
trigger.events Array Required Event to trigger
  • * | check_run | check_suite | commit_comment | create | delete | deployment | deployment_status | fork | gollum | issue_comment | issues | label | member | milestone | page_build | project_card | project_column | project | public | pull_request_review_comment | pull_request_review_thread | pull_request_review | pull_request | push | repository | repository_import | repository_vulnerability_alert | release | status | team_add | watch | branch_protection_rule | code_scanning_alert | deploy_key | discussion_comment | discussion | meta | package | registry_package | secret_scanning_alert_location | secret_scanning_alert | security_and_analysis | star | workflow_job | workflow_run
link Object Conditional API Gateway information
  • Valid only when creating a trigger and required
link.productId String Conditional API Gateway's product ID
link.apiName String Conditional API Gateway API name
link.stageName String Conditional API Gateway's stage name

Cloud Insight trigger

The following describes the request body for Cloud Insight triggers.

Field Type Required Description
trigger Object Required Information of the trigger
trigger.description String Optional Trigger description (byte)
  • 0 - 3000
trigger.parameters Object Optional Default parameters of the trigger
  • JSON in the form of {"key": "value"}
  • Priority of applying parameters when running triggers
    • 1st priority: runtime parameters passed at runtime
    • 2nd priority: default parameters of connected triggers
    • 3rd priority: default parameters in actions
    • 4th priority: default parameters of included packages
trigger.insightLink Object[] Required Cloud Insight information
trigger.insightLink[].prodKey String Required Cloud Insight event rule's prodKey
trigger.insightLink[].ruleGrpId String Required Cloud Insight event rule's ruleGrpId
trigger.insightLink[].reminderTime Integer Optional Cloud Insight event rule's reminder notification frequency (minute)
  • 5 - 720
trigger.insightLink[].enableNotiWhenEventClose Boolean Optional Whether to call Cloud Insight event rules at the end of an event
  • true | false (default)

Object Storage trigger

The following describes the request body for Object Storage triggers.

Caution

If an action attached to an Object Storage trigger uses the same bucket as an Object Storage event rule, recursive calls can result in increased usage and excessive costs.

Field Type Required Description
trigger Object Required Information of the trigger
trigger.description String Optional Trigger description (byte)
  • 0 - 3000
trigger.parameters Object Optional Default parameters of the trigger
  • JSON in the form of {"key": "value"}
  • Priority of applying parameters when running triggers
    • 1st priority: runtime parameters passed at runtime
    • 2nd priority: default parameters of connected triggers
    • 3rd priority: default parameters in actions
    • 4th priority: default parameters of included packages
trigger.objectStorageLink Object[] Required Object Storage information
trigger.objectStorageLink[].bucketName String Required Object Storage's bucket name
trigger.objectStorageLink[].eventRuleName String Required Object Storage's event rule name

SourceCommit trigger

The following describes the request body for creating or editing SourceCommit triggers.

Note

SourceCommit triggers are supported only on the VPC platform of the Korea Region.

Field Type Required Description
trigger Object Required Information of the trigger
trigger.description String Optional Trigger description (byte)
  • 0 - 3000
trigger.parameters Object Optional Default parameters of the trigger
  • JSON in the form of {"key": "value"}
  • Priority of applying parameters when running triggers
    • 1st priority: runtime parameters passed at runtime
    • 2nd priority: default parameters of connected triggers
    • 3rd priority: default parameters in actions
    • 4th priority: default parameters of included packages
trigger.sourceCommitLink Object[] Required SourceCommit information
trigger.sourceCommitLink[].enable Boolean Optional Webhook activation status of SourceCommit
  • true (default) | false
    trigger.sourceCommitLink[].repositoryName String Required SourceCommit repository name
    trigger.sourceCommitLink[].webhookName String Required SourceCommit webhook name

    Request example

    The request example is as follows:

    curl --location --request PUT 'https://cloudfunctions.apigw.ntruss.com/api/v2/triggers/trigger002?platform=vpc' \
--header 'Content-Type: application/json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Sub Account Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '<See below>'

    {
    "trigger": {
        "description": "cron Trigger",
        "cronOption": "0 10 * * *",
        "parameters": {

        }
    }
}

    Response

    This section describes the response format.

    Response body

    The following describes the response body for requested triggers.

    Cron trigger

    The following describes the response body for Cron triggers.

    Field Type Description
    content.cronOptions String Trigger cron execution option
    content.description String Trigger description
    content.name String Trigger name
    content.namespace String Namespace of the user
    content.parameters Object Default parameters of the trigger
    content.resourceId String Trigger's resource ID
    content.rules String Trigger action connection information
    content.triggerType String Trigger type

    GitHub trigger

    The following describes the response body for GitHub triggers.

    Field Type Description
    content.credentials Object Trigger GitHub integration information
    content.description String Trigger description
    content.events String Trigger's execution GitHub event option
    content.name String Trigger name
    content.namespace String Namespace of the user
    content.parameters Object Default parameters of the trigger
    content.resourceId String -
    content.rules String Trigger action connection information
    link.stageName String Trigger type

    Cloud Insight trigger

    The following describes the response body for Cloud Insight triggers.

    Field Type Description
    content.description String Trigger description
    content.name String Trigger name
    content.namespace String Namespace of the user
    content.parameters Object Default parameters of the trigger
    content.insightLink Object[] Event rule information of the connected Cloud Insight
    content.insightLink[].prodKey String Cloud Insight event rule's prodKey
    content.insightLink[].ruleGrpId String Cloud Insight event rule's groupId
    content.insightLink[].reminderTime Integer Cloud Insight event rule's reminder notification frequency (minute)
    content.insightLink[].enableNotiWhenEventClose Boolean Whether to call Cloud Insight event rules at the end of an event
    content.resourceId String -
    content.rules String -
    content.triggerType String -

    Object Storage trigger

    The following describes the response body for Object Storage triggers.

    Field Type Description
    content.description String Trigger description
    content.name String Trigger name
    content.namespace String Namespace of the user
    content.parameters Object Default parameters of the trigger
    content.objectStorageLink Object[] Event rule information of the connected Object Storage
    content.objectStorageLink[].bucketName String Object Storage event rule's bucket name
    content.objectStorageLink[].eventRuleName String Object Storage event rule name
    content.resourceId String Trigger's resource ID
    content.rules String Trigger action connection information
    content.triggerType String Trigger type

    SourceCommit trigger

    The following describes the response body for SourceCommit triggers.

    Field Type Description
    content.description String Trigger description
    content.name String Trigger name
    content.namespace String Namespace of the user
    content.parameters Object Default parameters of the trigger
    content.sourceCommitLink Object[] Repository information of the connected SourceCommit
    content.sourceCommitLink[].enable Boolean SourceCommit webhook activation status
    content.sourceCommitLink[].repositoryName String SourceCommit repository name
    content.sourceCommitLink[].webhookName String SourceCommit webhook name
    content.resourceId String Trigger's resource ID
    content.rules String Trigger action connection information
    content.triggerType String Trigger type

    Response status codes

    For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

    Response example

    The response example is as follows:

    {
    "content": {
        "cronOption": "0 10 * * *",
        "description": "cron Trigger",
        "limits": {},
        "name": "trigger002",
        "namespace": "****YBNz****",
        "parameters": {},
        "resourceId": "Nu3**",
        "rules": {},
        "triggerType": "Cron"
    }
}