Service Creation Webhook Context Schema

A service template's post-service creation webhook's request payload and rendered response support liquid templating. When firing the webhook, they receive a context object. This allows the webhook to behave dynamically based on the information in the context.

Context fields are accessed using Liquid's double handle bar notation: {{ identifier }}. When evaluated this would be replaced by the matching value in the context.

The service creation webhook context contains the following properties:

Service

When a template successfully executes, a new OpsLevel service is created. The webhook that can be optionally fired after that will have access to the context of the new service. These properties all refer to that service. For more information on how to configure a post-service creation webhook, see the guide to getting started with service creation.

Service Repository

When a service is created from a template, a new repository is created and associated with the service. The new repository's details will also be available to the webhook.

Template Run

The webhook is fired after a successful "template run" - i.e., a successful execution of the underlying cookiecutter template. The webhook context can access the inputs to and the outputs from the template run.

Template Run Inputs

The inputs to a template run are the values entered for the fields defined in the template's cookiecutter.json file. These are dynamically attached to the template_run.inputs field in the context.

Template Run Outputs

Every template run generated from the git forge write flow preceding a post-service creation webhook will have created a new repository for the service and an initial pull/merge request against that repository that adds the all the service's initial source code generated from the cookiecutter template. References to that repository and pull/merge request is accessible from the webhook's context.

User

Service creation is invoked by an individual user. These properties all refer to that user.

Owner

An owner reference is the Team responsible for a component in OpsLevel. The webhook context can contain a reference to the template owner as action_owner. This field may be blank if the Team specified as the owner has been deleted from OpsLevel. Also available is the new service's owner under service.owner.

Contact

Contacts are the communication channels used to get in touch with the template owner.

Response

The Response Details property injects an additional object into the Action’s context. These properties all refer to the response received from the webhook URL when invoking the action.

The response headers and body will be coerced into JSON if possible and can be referenced in the Liquid template as {{ response.headers.<property> }}.

Example Context

Post-Service Creation Webhook Context

{
  	"template_run": {
      "inputs": {
        "full_name": "First Last",
        "email": "[email protected]",
        "project_name": "Django Boilerplate",
        "django_version": "4.2.2"
      },
      "outputs": {
        "repo_url": "https://github.com/GROUP/django-boilerplate",
        "merge_request_url": "https://github.com/GROUP/django-boilerplate/pull/1",
        "merge_request_branch": "example-branch"
      }
    },
    "user":
    {
        "id": "SOME-ID",
        "name": "First Last",
        "email": "[email protected]",
        "href": "/users/SOME-ID",
        "role": "admin",
        "deactivated_at": null,
        "deactivated": false,
        "gravatar_src": "",
        "pending": false,
        "has_provider": false,
        "api_token_count": 3,
        "provisioned_by": "OpsLevel Admin"
    },
    "service":
    {
        "id": "SOME-ID",
        "name": "Django Test",
        "href": "/services/django_test",
        "product": null,
        "language": "Java",
        "framework": "Spring",
        "slug": "django_test",
        "tier_index": null,
        "lifecycle_index": null,
        "service_stat":
        {
            "num_checks": 9,
            "num_passing_checks": 4
        },
        "tags":
        [
            {
                "key": "is_approved",
                "value": "false",
                "id": "SOME-ID",
                "gid": "SOME-ID",
                "locked": false
            }
        ],
        "service_repositories":
        [
            {
                "id": 9999,
                "gid": "SOME-ID",
                "repo_path": "",
                "is_primary": false,
                "managed": false,
                "locked": false,
                "at_root": true,
                "display_name": "GROUP/django-test",
                "deep_url": "https://github.com/GROUP/django-test",
                "repository":
                {
                    "id": 9999,
                    "gid": "SOME-ID",
                    "name": "django-test",
                    "url": "https://github.com/GROUP/django-test",
                    "default_branch": "main",
                    "invalidated_at": null,
                    "active": true,
                    "forked": false,
                    "repo_key": "SOME-ID",
                    "display_name": "GROUP/django-test",
                    "description": null,
                    "type_string": "github",
                    "visible": true,
                    "archived_at": null,
                    "branch_protection": false,
                    "created_on": "2022-08-04T12:12:33.000000Z",
                    "account_name": "GROUP",
                    "type_display_name": "GitHub",
                    "icon": "github",
                    "integration_href": "https://app.opslevel.com/integrations/github/SOME-ID",
                    "locked": false,
                    "private": true,
                    "href": "/repositories/SOME-ID"
                }
            }
        ],
        "owner":
        {
            "id": "SOME-ID",
            "name": "Aes Sedai",
            "href": "/teams/aes_sedai",
            "slug": "aes_sedai",
            "service_stat":
            {
                "num_checks": 38,
                "num_passing_checks": 13
            },
            "manager":
            {
                "id": 9999999,
                "email": "[email protected]",
                "session_token": "SOME-ID",
                "last_sign_in_method": null,
                "name": "Moirane Damodred",
                "account_id": 999999,
                "accepted_tos_at": null,
                "role": "user",
                "provisioned_by_id": null,
                "provisioned_by_type": null,
                "provisioned_by_details": null,
                "deactivated_at": null,
                "created_at": "2022-06-29T22:43:06.619978Z",
                "updated_at": "2022-06-29T22:43:06.713373Z",
                "seen_team_cta": null
            },
            "tags":
            [],
            "contacts":
            [
                {
                    "id": 99999,
                    "address": "#the-white-tower",
                    "contact_method": "SLACK",
                    "display_name": "Slack Channel",
                    "display_type": null,
                    "target_href": "https://my-workspace.slack.com/channels/the-white-tower/",
                    "type": "Slack",
                    "short_name": "#the-white-tower",
                    "icon": "slack"
                }
            ]
        }
    },
    "action_owner":
    {
        "id": "SOME-ID",
        "name": "Team A",
        "href": "/teams/team_a",
        "slug": "team_a",
        "service_stat":
        {
            "num_checks": 0,
            "num_passing_checks": 0
        },
        "manager": null,
        "contacts":
        []
    },
}