Function createSubscription

apps/sim/lib/webhooks/providers/gitlab.ts:112–174

(ctx: SubscriptionContext)

  },

  async createSubscription(ctx: SubscriptionContext): Promise<SubscriptionResult | undefined> {
    const config = getProviderConfig(ctx.webhook)
    const accessToken = config.accessToken as string | undefined
    const projectId = config.projectId as string | undefined
    const triggerId = config.triggerId as string | undefined
    const host = config.host as string | undefined

    if (!accessToken)
      throw new Error('GitLab Personal Access Token is required to create the webhook.')
    if (!projectId) throw new Error('GitLab Project ID is required to create the webhook.')

    // Validate the optional self-managed host up front so a structurally unsafe
    // value surfaces as a clear error instead of an unhandled UnsafeGitLabHostError.
    try {
      getGitLabApiBase(host)
    } catch (error) {
      if (error instanceof UnsafeGitLabHostError) {
        throw new Error(
          'GitLab host is invalid. Provide a domain like gitlab.example.com (no protocol, path, or credentials).'
        )
      }
      throw error
    }

    const { getGitLabEventFlags } = await import('@/triggers/gitlab/utils')
    const secretToken = generateId()
    const res = await secureFetchWithValidation(gitlabProjectHooksUrl(projectId, host), {
      method: 'POST',
      headers: { 'PRIVATE-TOKEN': accessToken, 'Content-Type': 'application/json' },
      body: JSON.stringify({
        url: getNotificationUrl(ctx.webhook),
        token: secretToken,
        enable_ssl_verification: true,
        ...getGitLabEventFlags(triggerId ?? 'gitlab_webhook'),
      }),
    })

    if (!res.ok) {
      const detail = await res.text().catch(() => '')
      logger.error(`[${ctx.requestId}] Failed to create GitLab webhook (${res.status})`, { detail })
      if (res.status === 401)
        throw new Error(
          'GitLab authentication failed. Verify your Personal Access Token has the api scope.'
        )
      if (res.status === 403)
        throw new Error(
          'GitLab access denied. You need the Maintainer or Owner role on the project.'
        )
      if (res.status === 404) throw new Error('GitLab project not found. Verify the Project ID.')
      throw new Error(`Failed to create GitLab webhook: ${res.status}`)
    }

    const created = (await res.json().catch(() => ({}))) as { id?: number | string }
    if (created.id === undefined || created.id === null) {
      // The hook was created but we can't read its id — delete it by URL so it
      // is not orphaned in GitLab.
      await cleanupGitLabHookByUrl(projectId, accessToken, getNotificationUrl(ctx.webhook), host)
      throw new Error('GitLab webhook created but no hook ID was returned.')